google-api-python-client 2.192.0__py3-none-any.whl → 2.193.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {google_api_python_client-2.192.0.dist-info → google_api_python_client-2.193.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.192.0.dist-info → google_api_python_client-2.193.0.dist-info}/RECORD +136 -135
- {google_api_python_client-2.192.0.dist-info → google_api_python_client-2.193.0.dist-info}/WHEEL +1 -1
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +3 -3
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +4 -4
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +4 -4
- googleapiclient/discovery_cache/documents/admin.reports_v1.json +84 -2
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +84 -2
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +625 -84
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +939 -86
- googleapiclient/discovery_cache/documents/alloydb.v1.json +60 -11
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +64 -11
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +64 -11
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +28 -1
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +3 -3
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +6 -11
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +119 -1
- googleapiclient/discovery_cache/documents/apihub.v1.json +61 -13
- googleapiclient/discovery_cache/documents/backupdr.v1.json +84 -54
- googleapiclient/discovery_cache/documents/batch.v1.json +2 -2
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +11 -1
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +15 -3
- googleapiclient/discovery_cache/documents/bigquery.v2.json +60 -1
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +5 -1
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +4 -4
- googleapiclient/discovery_cache/documents/blogger.v3.json +4 -1
- googleapiclient/discovery_cache/documents/calendar.v3.json +9 -1
- googleapiclient/discovery_cache/documents/ces.v1.json +208 -12
- googleapiclient/discovery_cache/documents/ces.v1beta.json +334 -12
- googleapiclient/discovery_cache/documents/chat.v1.json +3 -3
- googleapiclient/discovery_cache/documents/classroom.v1.json +5 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +53 -5
- googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +148 -4
- googleapiclient/discovery_cache/documents/cloudtasks.v2.json +4 -4
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +3 -3
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +3 -3
- googleapiclient/discovery_cache/documents/compute.alpha.json +348 -25
- googleapiclient/discovery_cache/documents/compute.beta.json +1277 -125
- googleapiclient/discovery_cache/documents/compute.v1.json +6937 -2647
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +109 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +9 -5
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +9 -5
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +9 -5
- googleapiclient/discovery_cache/documents/css.v1.json +22 -2
- googleapiclient/discovery_cache/documents/datalineage.v1.json +1 -76
- googleapiclient/discovery_cache/documents/datamanager.v1.json +7 -7
- googleapiclient/discovery_cache/documents/datamigration.v1.json +239 -2
- googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +238 -1
- googleapiclient/discovery_cache/documents/dataplex.v1.json +327 -1348
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +2 -2
- googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json +280 -0
- googleapiclient/discovery_cache/documents/dfareporting.v4.json +3 -1
- googleapiclient/discovery_cache/documents/dfareporting.v5.json +25 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +566 -28
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +555 -25
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +563 -25
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +188 -25
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +1533 -311
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +1656 -434
- googleapiclient/discovery_cache/documents/dlp.v2.json +46 -8
- googleapiclient/discovery_cache/documents/docs.v1.json +3 -3
- googleapiclient/discovery_cache/documents/drive.v2.json +9 -5
- googleapiclient/discovery_cache/documents/drive.v3.json +7 -4
- googleapiclient/discovery_cache/documents/fcm.v1.json +3 -8
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +2 -2
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +5 -1
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +5 -1
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +28 -14
- googleapiclient/discovery_cache/documents/firestore.v1.json +8 -4
- googleapiclient/discovery_cache/documents/firestore.v1beta1.json +6 -2
- googleapiclient/discovery_cache/documents/gkehub.v1.json +5 -3
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +7 -3
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +9 -9
- googleapiclient/discovery_cache/documents/gkehub.v2.json +4 -2
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +4 -2
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +4 -2
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +2 -2
- googleapiclient/discovery_cache/documents/iam.v1.json +13 -3
- googleapiclient/discovery_cache/documents/kmsinventory.v1.json +4 -4
- googleapiclient/discovery_cache/documents/language.v1.json +358 -4
- googleapiclient/discovery_cache/documents/language.v1beta2.json +358 -4
- googleapiclient/discovery_cache/documents/language.v2.json +358 -4
- googleapiclient/discovery_cache/documents/logging.v2.json +7 -2
- googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +6 -6
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +6 -6
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +5 -5
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +5 -5
- googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +52 -30
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +216 -1
- googleapiclient/discovery_cache/documents/monitoring.v1.json +1 -20
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +68 -3
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +76 -1
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +76 -1
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +1 -183
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +1 -183
- googleapiclient/discovery_cache/documents/networkservices.v1.json +15 -1
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +15 -1
- googleapiclient/discovery_cache/documents/oracledatabase.v1.json +9 -1
- googleapiclient/discovery_cache/documents/orgpolicy.v2.json +3 -3
- googleapiclient/discovery_cache/documents/parametermanager.v1.json +2 -2
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +3 -3
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +1 -52
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +1 -52
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +2 -2
- googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/pubsub.v1.json +2 -2
- googleapiclient/discovery_cache/documents/realtimebidding.v1.json +26 -26
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +83 -3
- googleapiclient/discovery_cache/documents/redis.v1.json +75 -12
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +75 -12
- googleapiclient/discovery_cache/documents/run.v1.json +10 -6
- googleapiclient/discovery_cache/documents/run.v2.json +43 -6
- googleapiclient/discovery_cache/documents/searchads360.v0.json +125 -23
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +16 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +16 -1
- googleapiclient/discovery_cache/documents/sts.v1.json +11 -1
- googleapiclient/discovery_cache/documents/sts.v1beta.json +11 -1
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +19 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +2 -2
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +1 -76
- googleapiclient/discovery_cache/documents/videointelligence.v1.json +42 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +30 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +30 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +30 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +30 -1
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +144 -219
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.192.0.dist-info → google_api_python_client-2.193.0.dist-info}/licenses/LICENSE +0 -0
- {google_api_python_client-2.192.0.dist-info → google_api_python_client-2.193.0.dist-info}/top_level.txt +0 -0
|
@@ -376,6 +376,70 @@
|
|
|
376
376
|
"resources": {
|
|
377
377
|
"adGroupAds": {
|
|
378
378
|
"methods": {
|
|
379
|
+
"create": {
|
|
380
|
+
"description": "Creates an ad group ad.",
|
|
381
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroupAds",
|
|
382
|
+
"httpMethod": "POST",
|
|
383
|
+
"id": "displayvideo.advertisers.adGroupAds.create",
|
|
384
|
+
"parameterOrder": [
|
|
385
|
+
"advertiserId"
|
|
386
|
+
],
|
|
387
|
+
"parameters": {
|
|
388
|
+
"advertiserId": {
|
|
389
|
+
"description": "Output only. The unique ID of the advertiser the ad belongs to.",
|
|
390
|
+
"format": "int64",
|
|
391
|
+
"location": "path",
|
|
392
|
+
"pattern": "^[^/]+$",
|
|
393
|
+
"required": true,
|
|
394
|
+
"type": "string"
|
|
395
|
+
}
|
|
396
|
+
},
|
|
397
|
+
"path": "v3/advertisers/{+advertiserId}/adGroupAds",
|
|
398
|
+
"request": {
|
|
399
|
+
"$ref": "AdGroupAd"
|
|
400
|
+
},
|
|
401
|
+
"response": {
|
|
402
|
+
"$ref": "AdGroupAd"
|
|
403
|
+
},
|
|
404
|
+
"scopes": [
|
|
405
|
+
"https://www.googleapis.com/auth/display-video"
|
|
406
|
+
]
|
|
407
|
+
},
|
|
408
|
+
"delete": {
|
|
409
|
+
"description": "Deletes an ad group ad.",
|
|
410
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}",
|
|
411
|
+
"httpMethod": "DELETE",
|
|
412
|
+
"id": "displayvideo.advertisers.adGroupAds.delete",
|
|
413
|
+
"parameterOrder": [
|
|
414
|
+
"advertiserId",
|
|
415
|
+
"adGroupAdId"
|
|
416
|
+
],
|
|
417
|
+
"parameters": {
|
|
418
|
+
"adGroupAdId": {
|
|
419
|
+
"description": "Required. The ID of the ad to delete.",
|
|
420
|
+
"format": "int64",
|
|
421
|
+
"location": "path",
|
|
422
|
+
"pattern": "^[^/]+$",
|
|
423
|
+
"required": true,
|
|
424
|
+
"type": "string"
|
|
425
|
+
},
|
|
426
|
+
"advertiserId": {
|
|
427
|
+
"description": "Required. The ID of the advertiser the ad belongs to.",
|
|
428
|
+
"format": "int64",
|
|
429
|
+
"location": "path",
|
|
430
|
+
"pattern": "^[^/]+$",
|
|
431
|
+
"required": true,
|
|
432
|
+
"type": "string"
|
|
433
|
+
}
|
|
434
|
+
},
|
|
435
|
+
"path": "v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}",
|
|
436
|
+
"response": {
|
|
437
|
+
"$ref": "Empty"
|
|
438
|
+
},
|
|
439
|
+
"scopes": [
|
|
440
|
+
"https://www.googleapis.com/auth/display-video"
|
|
441
|
+
]
|
|
442
|
+
},
|
|
379
443
|
"get": {
|
|
380
444
|
"description": "Gets an ad group ad.",
|
|
381
445
|
"flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}",
|
|
@@ -457,11 +521,84 @@
|
|
|
457
521
|
"scopes": [
|
|
458
522
|
"https://www.googleapis.com/auth/display-video"
|
|
459
523
|
]
|
|
524
|
+
},
|
|
525
|
+
"patch": {
|
|
526
|
+
"description": "Updates an ad group ad.",
|
|
527
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}",
|
|
528
|
+
"httpMethod": "PATCH",
|
|
529
|
+
"id": "displayvideo.advertisers.adGroupAds.patch",
|
|
530
|
+
"parameterOrder": [
|
|
531
|
+
"advertiserId",
|
|
532
|
+
"adGroupAdId"
|
|
533
|
+
],
|
|
534
|
+
"parameters": {
|
|
535
|
+
"adGroupAdId": {
|
|
536
|
+
"description": "Output only. The unique ID of the ad. Assigned by the system.",
|
|
537
|
+
"format": "int64",
|
|
538
|
+
"location": "path",
|
|
539
|
+
"pattern": "^[^/]+$",
|
|
540
|
+
"required": true,
|
|
541
|
+
"type": "string"
|
|
542
|
+
},
|
|
543
|
+
"advertiserId": {
|
|
544
|
+
"description": "Output only. The unique ID of the advertiser the ad belongs to.",
|
|
545
|
+
"format": "int64",
|
|
546
|
+
"location": "path",
|
|
547
|
+
"pattern": "^[^/]+$",
|
|
548
|
+
"required": true,
|
|
549
|
+
"type": "string"
|
|
550
|
+
},
|
|
551
|
+
"updateMask": {
|
|
552
|
+
"description": "Required. The mask to control which fields to update.",
|
|
553
|
+
"format": "google-fieldmask",
|
|
554
|
+
"location": "query",
|
|
555
|
+
"type": "string"
|
|
556
|
+
}
|
|
557
|
+
},
|
|
558
|
+
"path": "v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}",
|
|
559
|
+
"request": {
|
|
560
|
+
"$ref": "AdGroupAd"
|
|
561
|
+
},
|
|
562
|
+
"response": {
|
|
563
|
+
"$ref": "AdGroupAd"
|
|
564
|
+
},
|
|
565
|
+
"scopes": [
|
|
566
|
+
"https://www.googleapis.com/auth/display-video"
|
|
567
|
+
]
|
|
460
568
|
}
|
|
461
569
|
}
|
|
462
570
|
},
|
|
463
571
|
"adGroups": {
|
|
464
572
|
"methods": {
|
|
573
|
+
"bulkEditAssignedTargetingOptions": {
|
|
574
|
+
"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.",
|
|
575
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions",
|
|
576
|
+
"httpMethod": "POST",
|
|
577
|
+
"id": "displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions",
|
|
578
|
+
"parameterOrder": [
|
|
579
|
+
"advertiserId"
|
|
580
|
+
],
|
|
581
|
+
"parameters": {
|
|
582
|
+
"advertiserId": {
|
|
583
|
+
"description": "Required. The ID of the advertiser the ad groups belong to.",
|
|
584
|
+
"format": "int64",
|
|
585
|
+
"location": "path",
|
|
586
|
+
"pattern": "^[^/]+$",
|
|
587
|
+
"required": true,
|
|
588
|
+
"type": "string"
|
|
589
|
+
}
|
|
590
|
+
},
|
|
591
|
+
"path": "v3/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions",
|
|
592
|
+
"request": {
|
|
593
|
+
"$ref": "BulkEditAdGroupAssignedTargetingOptionsRequest"
|
|
594
|
+
},
|
|
595
|
+
"response": {
|
|
596
|
+
"$ref": "BulkEditAdGroupAssignedTargetingOptionsResponse"
|
|
597
|
+
},
|
|
598
|
+
"scopes": [
|
|
599
|
+
"https://www.googleapis.com/auth/display-video"
|
|
600
|
+
]
|
|
601
|
+
},
|
|
465
602
|
"bulkListAdGroupAssignedTargetingOptions": {
|
|
466
603
|
"description": "Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.",
|
|
467
604
|
"flatPath": "v3/advertisers/{advertisersId}/adGroups:bulkListAdGroupAssignedTargetingOptions",
|
|
@@ -516,6 +653,70 @@
|
|
|
516
653
|
"https://www.googleapis.com/auth/display-video"
|
|
517
654
|
]
|
|
518
655
|
},
|
|
656
|
+
"create": {
|
|
657
|
+
"description": "Creates a new ad group. Returns the newly created ad group if successful.",
|
|
658
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroups",
|
|
659
|
+
"httpMethod": "POST",
|
|
660
|
+
"id": "displayvideo.advertisers.adGroups.create",
|
|
661
|
+
"parameterOrder": [
|
|
662
|
+
"advertiserId"
|
|
663
|
+
],
|
|
664
|
+
"parameters": {
|
|
665
|
+
"advertiserId": {
|
|
666
|
+
"description": "Output only. The unique ID of the advertiser the ad group belongs to.",
|
|
667
|
+
"format": "int64",
|
|
668
|
+
"location": "path",
|
|
669
|
+
"pattern": "^[^/]+$",
|
|
670
|
+
"required": true,
|
|
671
|
+
"type": "string"
|
|
672
|
+
}
|
|
673
|
+
},
|
|
674
|
+
"path": "v3/advertisers/{+advertiserId}/adGroups",
|
|
675
|
+
"request": {
|
|
676
|
+
"$ref": "AdGroup"
|
|
677
|
+
},
|
|
678
|
+
"response": {
|
|
679
|
+
"$ref": "AdGroup"
|
|
680
|
+
},
|
|
681
|
+
"scopes": [
|
|
682
|
+
"https://www.googleapis.com/auth/display-video"
|
|
683
|
+
]
|
|
684
|
+
},
|
|
685
|
+
"delete": {
|
|
686
|
+
"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.",
|
|
687
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}",
|
|
688
|
+
"httpMethod": "DELETE",
|
|
689
|
+
"id": "displayvideo.advertisers.adGroups.delete",
|
|
690
|
+
"parameterOrder": [
|
|
691
|
+
"advertiserId",
|
|
692
|
+
"adGroupId"
|
|
693
|
+
],
|
|
694
|
+
"parameters": {
|
|
695
|
+
"adGroupId": {
|
|
696
|
+
"description": "Required. The ID of the ad group to delete.",
|
|
697
|
+
"format": "int64",
|
|
698
|
+
"location": "path",
|
|
699
|
+
"pattern": "^[^/]+$",
|
|
700
|
+
"required": true,
|
|
701
|
+
"type": "string"
|
|
702
|
+
},
|
|
703
|
+
"advertiserId": {
|
|
704
|
+
"description": "Required. The ID of the advertiser this ad group belongs to.",
|
|
705
|
+
"format": "int64",
|
|
706
|
+
"location": "path",
|
|
707
|
+
"pattern": "^[^/]+$",
|
|
708
|
+
"required": true,
|
|
709
|
+
"type": "string"
|
|
710
|
+
}
|
|
711
|
+
},
|
|
712
|
+
"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}",
|
|
713
|
+
"response": {
|
|
714
|
+
"$ref": "Empty"
|
|
715
|
+
},
|
|
716
|
+
"scopes": [
|
|
717
|
+
"https://www.googleapis.com/auth/display-video"
|
|
718
|
+
]
|
|
719
|
+
},
|
|
519
720
|
"get": {
|
|
520
721
|
"description": "Gets an ad group.",
|
|
521
722
|
"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}",
|
|
@@ -597,6 +798,50 @@
|
|
|
597
798
|
"scopes": [
|
|
598
799
|
"https://www.googleapis.com/auth/display-video"
|
|
599
800
|
]
|
|
801
|
+
},
|
|
802
|
+
"patch": {
|
|
803
|
+
"description": "Updates an existing ad group. Returns the updated ad group if successful.",
|
|
804
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}",
|
|
805
|
+
"httpMethod": "PATCH",
|
|
806
|
+
"id": "displayvideo.advertisers.adGroups.patch",
|
|
807
|
+
"parameterOrder": [
|
|
808
|
+
"advertiserId",
|
|
809
|
+
"adGroupId"
|
|
810
|
+
],
|
|
811
|
+
"parameters": {
|
|
812
|
+
"adGroupId": {
|
|
813
|
+
"description": "Output only. The unique ID of the ad group. Assigned by the system.",
|
|
814
|
+
"format": "int64",
|
|
815
|
+
"location": "path",
|
|
816
|
+
"pattern": "^[^/]+$",
|
|
817
|
+
"required": true,
|
|
818
|
+
"type": "string"
|
|
819
|
+
},
|
|
820
|
+
"advertiserId": {
|
|
821
|
+
"description": "Output only. The unique ID of the advertiser the ad group belongs to.",
|
|
822
|
+
"format": "int64",
|
|
823
|
+
"location": "path",
|
|
824
|
+
"pattern": "^[^/]+$",
|
|
825
|
+
"required": true,
|
|
826
|
+
"type": "string"
|
|
827
|
+
},
|
|
828
|
+
"updateMask": {
|
|
829
|
+
"description": "Required. The mask to control which fields to update.",
|
|
830
|
+
"format": "google-fieldmask",
|
|
831
|
+
"location": "query",
|
|
832
|
+
"type": "string"
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}",
|
|
836
|
+
"request": {
|
|
837
|
+
"$ref": "AdGroup"
|
|
838
|
+
},
|
|
839
|
+
"response": {
|
|
840
|
+
"$ref": "AdGroup"
|
|
841
|
+
},
|
|
842
|
+
"scopes": [
|
|
843
|
+
"https://www.googleapis.com/auth/display-video"
|
|
844
|
+
]
|
|
600
845
|
}
|
|
601
846
|
},
|
|
602
847
|
"resources": {
|
|
@@ -604,20 +849,19 @@
|
|
|
604
849
|
"resources": {
|
|
605
850
|
"assignedTargetingOptions": {
|
|
606
851
|
"methods": {
|
|
607
|
-
"
|
|
608
|
-
"description": "
|
|
609
|
-
"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
|
|
610
|
-
"httpMethod": "
|
|
611
|
-
"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.
|
|
852
|
+
"create": {
|
|
853
|
+
"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.",
|
|
854
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
|
|
855
|
+
"httpMethod": "POST",
|
|
856
|
+
"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create",
|
|
612
857
|
"parameterOrder": [
|
|
613
858
|
"advertiserId",
|
|
614
859
|
"adGroupId",
|
|
615
|
-
"targetingType"
|
|
616
|
-
"assignedTargetingOptionId"
|
|
860
|
+
"targetingType"
|
|
617
861
|
],
|
|
618
862
|
"parameters": {
|
|
619
863
|
"adGroupId": {
|
|
620
|
-
"description": "Required. The ID of the ad group the assigned targeting option
|
|
864
|
+
"description": "Required. The ID of the ad group the assigned targeting option will belong to.",
|
|
621
865
|
"format": "int64",
|
|
622
866
|
"location": "path",
|
|
623
867
|
"pattern": "^[^/]+$",
|
|
@@ -632,15 +876,8 @@
|
|
|
632
876
|
"required": true,
|
|
633
877
|
"type": "string"
|
|
634
878
|
},
|
|
635
|
-
"assignedTargetingOptionId": {
|
|
636
|
-
"description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.",
|
|
637
|
-
"location": "path",
|
|
638
|
-
"pattern": "^[^/]+$",
|
|
639
|
-
"required": true,
|
|
640
|
-
"type": "string"
|
|
641
|
-
},
|
|
642
879
|
"targetingType": {
|
|
643
|
-
"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types
|
|
880
|
+
"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`",
|
|
644
881
|
"enum": [
|
|
645
882
|
"TARGETING_TYPE_UNSPECIFIED",
|
|
646
883
|
"TARGETING_TYPE_CHANNEL",
|
|
@@ -751,7 +988,10 @@
|
|
|
751
988
|
"type": "string"
|
|
752
989
|
}
|
|
753
990
|
},
|
|
754
|
-
"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
|
|
991
|
+
"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
|
|
992
|
+
"request": {
|
|
993
|
+
"$ref": "AssignedTargetingOption"
|
|
994
|
+
},
|
|
755
995
|
"response": {
|
|
756
996
|
"$ref": "AssignedTargetingOption"
|
|
757
997
|
},
|
|
@@ -759,19 +999,20 @@
|
|
|
759
999
|
"https://www.googleapis.com/auth/display-video"
|
|
760
1000
|
]
|
|
761
1001
|
},
|
|
762
|
-
"
|
|
763
|
-
"description": "
|
|
764
|
-
"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
|
|
765
|
-
"httpMethod": "
|
|
766
|
-
"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.
|
|
1002
|
+
"delete": {
|
|
1003
|
+
"description": "Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.",
|
|
1004
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}",
|
|
1005
|
+
"httpMethod": "DELETE",
|
|
1006
|
+
"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete",
|
|
767
1007
|
"parameterOrder": [
|
|
768
1008
|
"advertiserId",
|
|
769
1009
|
"adGroupId",
|
|
770
|
-
"targetingType"
|
|
1010
|
+
"targetingType",
|
|
1011
|
+
"assignedTargetingOptionId"
|
|
771
1012
|
],
|
|
772
1013
|
"parameters": {
|
|
773
1014
|
"adGroupId": {
|
|
774
|
-
"description": "Required. The ID of the ad group
|
|
1015
|
+
"description": "Required. The ID of the ad group the assigned targeting option belongs to.",
|
|
775
1016
|
"format": "int64",
|
|
776
1017
|
"location": "path",
|
|
777
1018
|
"pattern": "^[^/]+$",
|
|
@@ -786,29 +1027,15 @@
|
|
|
786
1027
|
"required": true,
|
|
787
1028
|
"type": "string"
|
|
788
1029
|
},
|
|
789
|
-
"
|
|
790
|
-
"description": "
|
|
791
|
-
"location": "
|
|
792
|
-
"
|
|
793
|
-
|
|
794
|
-
"orderBy": {
|
|
795
|
-
"description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.",
|
|
796
|
-
"location": "query",
|
|
797
|
-
"type": "string"
|
|
798
|
-
},
|
|
799
|
-
"pageSize": {
|
|
800
|
-
"description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
|
|
801
|
-
"format": "int32",
|
|
802
|
-
"location": "query",
|
|
803
|
-
"type": "integer"
|
|
804
|
-
},
|
|
805
|
-
"pageToken": {
|
|
806
|
-
"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.",
|
|
807
|
-
"location": "query",
|
|
1030
|
+
"assignedTargetingOptionId": {
|
|
1031
|
+
"description": "Required. The ID of the assigned targeting option to delete.",
|
|
1032
|
+
"location": "path",
|
|
1033
|
+
"pattern": "^[^/]+$",
|
|
1034
|
+
"required": true,
|
|
808
1035
|
"type": "string"
|
|
809
1036
|
},
|
|
810
1037
|
"targetingType": {
|
|
811
|
-
"description": "Required. Identifies the type of assigned targeting
|
|
1038
|
+
"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`",
|
|
812
1039
|
"enum": [
|
|
813
1040
|
"TARGETING_TYPE_UNSPECIFIED",
|
|
814
1041
|
"TARGETING_TYPE_CHANNEL",
|
|
@@ -919,131 +1146,454 @@
|
|
|
919
1146
|
"type": "string"
|
|
920
1147
|
}
|
|
921
1148
|
},
|
|
922
|
-
"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
|
|
1149
|
+
"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}",
|
|
923
1150
|
"response": {
|
|
924
|
-
"$ref": "
|
|
1151
|
+
"$ref": "Empty"
|
|
925
1152
|
},
|
|
926
1153
|
"scopes": [
|
|
927
1154
|
"https://www.googleapis.com/auth/display-video"
|
|
928
1155
|
]
|
|
929
|
-
}
|
|
930
|
-
}
|
|
931
|
-
}
|
|
932
|
-
}
|
|
933
|
-
}
|
|
934
|
-
}
|
|
935
|
-
},
|
|
936
|
-
"assets": {
|
|
937
|
-
"methods": {
|
|
938
|
-
"upload": {
|
|
939
|
-
"description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).",
|
|
940
|
-
"flatPath": "v3/advertisers/{advertisersId}/assets",
|
|
941
|
-
"httpMethod": "POST",
|
|
942
|
-
"id": "displayvideo.advertisers.assets.upload",
|
|
943
|
-
"mediaUpload": {
|
|
944
|
-
"accept": [
|
|
945
|
-
"*/*"
|
|
946
|
-
],
|
|
947
|
-
"protocols": {
|
|
948
|
-
"simple": {
|
|
949
|
-
"multipart": true,
|
|
950
|
-
"path": "/upload/v3/advertisers/{+advertiserId}/assets"
|
|
951
|
-
}
|
|
952
|
-
}
|
|
953
1156
|
},
|
|
1157
|
+
"get": {
|
|
1158
|
+
"description": "Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.",
|
|
1159
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}",
|
|
1160
|
+
"httpMethod": "GET",
|
|
1161
|
+
"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get",
|
|
954
1162
|
"parameterOrder": [
|
|
955
|
-
"advertiserId"
|
|
1163
|
+
"advertiserId",
|
|
1164
|
+
"adGroupId",
|
|
1165
|
+
"targetingType",
|
|
1166
|
+
"assignedTargetingOptionId"
|
|
956
1167
|
],
|
|
957
1168
|
"parameters": {
|
|
958
|
-
"
|
|
959
|
-
"description": "Required. The ID of the
|
|
1169
|
+
"adGroupId": {
|
|
1170
|
+
"description": "Required. The ID of the ad group the assigned targeting option belongs to.",
|
|
960
1171
|
"format": "int64",
|
|
961
1172
|
"location": "path",
|
|
962
1173
|
"pattern": "^[^/]+$",
|
|
963
1174
|
"required": true,
|
|
964
1175
|
"type": "string"
|
|
965
|
-
}
|
|
966
1176
|
},
|
|
967
|
-
"
|
|
968
|
-
"
|
|
969
|
-
"
|
|
1177
|
+
"advertiserId": {
|
|
1178
|
+
"description": "Required. The ID of the advertiser the ad group belongs to.",
|
|
1179
|
+
"format": "int64",
|
|
1180
|
+
"location": "path",
|
|
1181
|
+
"pattern": "^[^/]+$",
|
|
1182
|
+
"required": true,
|
|
1183
|
+
"type": "string"
|
|
970
1184
|
},
|
|
971
|
-
"
|
|
972
|
-
"
|
|
1185
|
+
"assignedTargetingOptionId": {
|
|
1186
|
+
"description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.",
|
|
1187
|
+
"location": "path",
|
|
1188
|
+
"pattern": "^[^/]+$",
|
|
1189
|
+
"required": true,
|
|
1190
|
+
"type": "string"
|
|
973
1191
|
},
|
|
974
|
-
"
|
|
975
|
-
"
|
|
1192
|
+
"targetingType": {
|
|
1193
|
+
"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`",
|
|
1194
|
+
"enum": [
|
|
1195
|
+
"TARGETING_TYPE_UNSPECIFIED",
|
|
1196
|
+
"TARGETING_TYPE_CHANNEL",
|
|
1197
|
+
"TARGETING_TYPE_APP_CATEGORY",
|
|
1198
|
+
"TARGETING_TYPE_APP",
|
|
1199
|
+
"TARGETING_TYPE_URL",
|
|
1200
|
+
"TARGETING_TYPE_DAY_AND_TIME",
|
|
1201
|
+
"TARGETING_TYPE_AGE_RANGE",
|
|
1202
|
+
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
|
|
1203
|
+
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
|
|
1204
|
+
"TARGETING_TYPE_GENDER",
|
|
1205
|
+
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
|
|
1206
|
+
"TARGETING_TYPE_USER_REWARDED_CONTENT",
|
|
1207
|
+
"TARGETING_TYPE_PARENTAL_STATUS",
|
|
1208
|
+
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
|
|
1209
|
+
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
|
|
1210
|
+
"TARGETING_TYPE_DEVICE_TYPE",
|
|
1211
|
+
"TARGETING_TYPE_AUDIENCE_GROUP",
|
|
1212
|
+
"TARGETING_TYPE_BROWSER",
|
|
1213
|
+
"TARGETING_TYPE_HOUSEHOLD_INCOME",
|
|
1214
|
+
"TARGETING_TYPE_ON_SCREEN_POSITION",
|
|
1215
|
+
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
|
|
1216
|
+
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
|
|
1217
|
+
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
|
|
1218
|
+
"TARGETING_TYPE_ENVIRONMENT",
|
|
1219
|
+
"TARGETING_TYPE_CARRIER_AND_ISP",
|
|
1220
|
+
"TARGETING_TYPE_OPERATING_SYSTEM",
|
|
1221
|
+
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
|
|
1222
|
+
"TARGETING_TYPE_KEYWORD",
|
|
1223
|
+
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
|
|
1224
|
+
"TARGETING_TYPE_VIEWABILITY",
|
|
1225
|
+
"TARGETING_TYPE_CATEGORY",
|
|
1226
|
+
"TARGETING_TYPE_INVENTORY_SOURCE",
|
|
1227
|
+
"TARGETING_TYPE_LANGUAGE",
|
|
1228
|
+
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
|
|
1229
|
+
"TARGETING_TYPE_GEO_REGION",
|
|
1230
|
+
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
|
|
1231
|
+
"TARGETING_TYPE_EXCHANGE",
|
|
1232
|
+
"TARGETING_TYPE_SUB_EXCHANGE",
|
|
1233
|
+
"TARGETING_TYPE_POI",
|
|
1234
|
+
"TARGETING_TYPE_BUSINESS_CHAIN",
|
|
1235
|
+
"TARGETING_TYPE_CONTENT_DURATION",
|
|
1236
|
+
"TARGETING_TYPE_CONTENT_STREAM_TYPE",
|
|
1237
|
+
"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
|
|
1238
|
+
"TARGETING_TYPE_OMID",
|
|
1239
|
+
"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
|
|
1240
|
+
"TARGETING_TYPE_CONTENT_GENRE",
|
|
1241
|
+
"TARGETING_TYPE_YOUTUBE_VIDEO",
|
|
1242
|
+
"TARGETING_TYPE_YOUTUBE_CHANNEL",
|
|
1243
|
+
"TARGETING_TYPE_SESSION_POSITION",
|
|
1244
|
+
"TARGETING_TYPE_CONTENT_THEME_EXCLUSION"
|
|
976
1245
|
],
|
|
977
|
-
"
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
"
|
|
982
|
-
"
|
|
983
|
-
"
|
|
984
|
-
"
|
|
985
|
-
"
|
|
986
|
-
"
|
|
987
|
-
"
|
|
988
|
-
"
|
|
989
|
-
"
|
|
1246
|
+
"enumDescriptions": [
|
|
1247
|
+
"Default value when type is not specified or is unknown in this version.",
|
|
1248
|
+
"Target a channel (a custom group of related websites or apps).",
|
|
1249
|
+
"Target an app category (for example, education or puzzle games).",
|
|
1250
|
+
"Target a specific app (for example, Angry Birds).",
|
|
1251
|
+
"Target a specific url (for example, quora.com).",
|
|
1252
|
+
"Target ads during a chosen time period on a specific day.",
|
|
1253
|
+
"Target ads to a specific age range (for example, 18-24).",
|
|
1254
|
+
"Target ads to the specified regions on a regional location list.",
|
|
1255
|
+
"Target ads to the specified points of interest on a proximity location list.",
|
|
1256
|
+
"Target ads to a specific gender (for example, female or male).",
|
|
1257
|
+
"Target a specific video player size for video ads.",
|
|
1258
|
+
"Target user rewarded content for video ads.",
|
|
1259
|
+
"Target ads to a specific parental status (for example, parent or not a parent).",
|
|
1260
|
+
"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
|
|
1261
|
+
"Target ads in a specific content outstream position.",
|
|
1262
|
+
"Target ads to a specific device type (for example, tablet or connected TV).",
|
|
1263
|
+
"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
|
|
1264
|
+
"Target ads to specific web browsers (for example, Chrome).",
|
|
1265
|
+
"Target ads to a specific household income range (for example, top 10%).",
|
|
1266
|
+
"Target ads in a specific on screen position.",
|
|
1267
|
+
"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
|
|
1268
|
+
"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
|
|
1269
|
+
"Filter website content by sensitive categories (for example, adult).",
|
|
1270
|
+
"Target ads to a specific environment (for example, web or app).",
|
|
1271
|
+
"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
|
|
1272
|
+
"Target ads to a specific operating system (for example, macOS).",
|
|
1273
|
+
"Target ads to a specific device make or model (for example, Roku or Samsung).",
|
|
1274
|
+
"Target ads to a specific keyword (for example, dog or retriever).",
|
|
1275
|
+
"Target ads to a specific negative keyword list.",
|
|
1276
|
+
"Target ads to a specific viewability (for example, 80% viewable).",
|
|
1277
|
+
"Target ads to a specific content category (for example, arts & entertainment).",
|
|
1278
|
+
"Purchase impressions from specific deals and auction packages.",
|
|
1279
|
+
"Target ads to a specific language (for example, English or Japanese).",
|
|
1280
|
+
"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
|
|
1281
|
+
"Target ads to a specific regional location (for example, a city or state).",
|
|
1282
|
+
"Purchase impressions from a group of deals and auction packages.",
|
|
1283
|
+
"Purchase impressions from specific exchanges.",
|
|
1284
|
+
"Purchase impressions from specific sub-exchanges.",
|
|
1285
|
+
"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
|
|
1286
|
+
"Target ads around locations of a business chain within a specific geo region.",
|
|
1287
|
+
"Target ads to a specific video content duration.",
|
|
1288
|
+
"Target ads to a specific video content stream type.",
|
|
1289
|
+
"Target ads to a specific native content position.",
|
|
1290
|
+
"Target ads in an Open Measurement enabled inventory.",
|
|
1291
|
+
"Target ads to a specific audio content type.",
|
|
1292
|
+
"Target ads to a specific content genre.",
|
|
1293
|
+
"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
|
|
1294
|
+
"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
|
|
1295
|
+
"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.",
|
|
1296
|
+
"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources."
|
|
990
1297
|
],
|
|
991
|
-
"parameters": {
|
|
992
|
-
"advertiserId": {
|
|
993
|
-
"description": "Output only. The unique ID of the advertiser the campaign belongs to.",
|
|
994
|
-
"format": "int64",
|
|
995
1298
|
"location": "path",
|
|
996
1299
|
"pattern": "^[^/]+$",
|
|
997
1300
|
"required": true,
|
|
998
1301
|
"type": "string"
|
|
999
1302
|
}
|
|
1000
1303
|
},
|
|
1001
|
-
"path": "v3/advertisers/{+advertiserId}/
|
|
1002
|
-
"request": {
|
|
1003
|
-
"$ref": "Campaign"
|
|
1004
|
-
},
|
|
1304
|
+
"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}",
|
|
1005
1305
|
"response": {
|
|
1006
|
-
"$ref": "
|
|
1306
|
+
"$ref": "AssignedTargetingOption"
|
|
1007
1307
|
},
|
|
1008
1308
|
"scopes": [
|
|
1009
|
-
"https://www.googleapis.com/auth/display-video"
|
|
1010
|
-
"https://www.googleapis.com/auth/display-video-mediaplanning"
|
|
1309
|
+
"https://www.googleapis.com/auth/display-video"
|
|
1011
1310
|
]
|
|
1012
1311
|
},
|
|
1013
|
-
"
|
|
1014
|
-
"description": "
|
|
1015
|
-
"flatPath": "v3/advertisers/{advertisersId}/
|
|
1016
|
-
"httpMethod": "
|
|
1017
|
-
"id": "displayvideo.advertisers.
|
|
1312
|
+
"list": {
|
|
1313
|
+
"description": "Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.",
|
|
1314
|
+
"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
|
|
1315
|
+
"httpMethod": "GET",
|
|
1316
|
+
"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list",
|
|
1018
1317
|
"parameterOrder": [
|
|
1019
1318
|
"advertiserId",
|
|
1020
|
-
"
|
|
1319
|
+
"adGroupId",
|
|
1320
|
+
"targetingType"
|
|
1021
1321
|
],
|
|
1022
1322
|
"parameters": {
|
|
1023
|
-
"
|
|
1024
|
-
"description": "The ID of the
|
|
1323
|
+
"adGroupId": {
|
|
1324
|
+
"description": "Required. The ID of the ad group to list assigned targeting options for.",
|
|
1025
1325
|
"format": "int64",
|
|
1026
1326
|
"location": "path",
|
|
1027
1327
|
"pattern": "^[^/]+$",
|
|
1028
1328
|
"required": true,
|
|
1029
1329
|
"type": "string"
|
|
1030
1330
|
},
|
|
1031
|
-
"
|
|
1032
|
-
"description": "The ID of the
|
|
1331
|
+
"advertiserId": {
|
|
1332
|
+
"description": "Required. The ID of the advertiser the ad group belongs to.",
|
|
1033
1333
|
"format": "int64",
|
|
1034
1334
|
"location": "path",
|
|
1035
1335
|
"pattern": "^[^/]+$",
|
|
1036
1336
|
"required": true,
|
|
1037
1337
|
"type": "string"
|
|
1038
|
-
}
|
|
1039
1338
|
},
|
|
1040
|
-
"
|
|
1041
|
-
"
|
|
1042
|
-
"
|
|
1339
|
+
"filter": {
|
|
1340
|
+
"description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
|
|
1341
|
+
"location": "query",
|
|
1342
|
+
"type": "string"
|
|
1043
1343
|
},
|
|
1044
|
-
"
|
|
1045
|
-
"
|
|
1046
|
-
"
|
|
1344
|
+
"orderBy": {
|
|
1345
|
+
"description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.",
|
|
1346
|
+
"location": "query",
|
|
1347
|
+
"type": "string"
|
|
1348
|
+
},
|
|
1349
|
+
"pageSize": {
|
|
1350
|
+
"description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
|
|
1351
|
+
"format": "int32",
|
|
1352
|
+
"location": "query",
|
|
1353
|
+
"type": "integer"
|
|
1354
|
+
},
|
|
1355
|
+
"pageToken": {
|
|
1356
|
+
"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.",
|
|
1357
|
+
"location": "query",
|
|
1358
|
+
"type": "string"
|
|
1359
|
+
},
|
|
1360
|
+
"targetingType": {
|
|
1361
|
+
"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`",
|
|
1362
|
+
"enum": [
|
|
1363
|
+
"TARGETING_TYPE_UNSPECIFIED",
|
|
1364
|
+
"TARGETING_TYPE_CHANNEL",
|
|
1365
|
+
"TARGETING_TYPE_APP_CATEGORY",
|
|
1366
|
+
"TARGETING_TYPE_APP",
|
|
1367
|
+
"TARGETING_TYPE_URL",
|
|
1368
|
+
"TARGETING_TYPE_DAY_AND_TIME",
|
|
1369
|
+
"TARGETING_TYPE_AGE_RANGE",
|
|
1370
|
+
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
|
|
1371
|
+
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
|
|
1372
|
+
"TARGETING_TYPE_GENDER",
|
|
1373
|
+
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
|
|
1374
|
+
"TARGETING_TYPE_USER_REWARDED_CONTENT",
|
|
1375
|
+
"TARGETING_TYPE_PARENTAL_STATUS",
|
|
1376
|
+
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
|
|
1377
|
+
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
|
|
1378
|
+
"TARGETING_TYPE_DEVICE_TYPE",
|
|
1379
|
+
"TARGETING_TYPE_AUDIENCE_GROUP",
|
|
1380
|
+
"TARGETING_TYPE_BROWSER",
|
|
1381
|
+
"TARGETING_TYPE_HOUSEHOLD_INCOME",
|
|
1382
|
+
"TARGETING_TYPE_ON_SCREEN_POSITION",
|
|
1383
|
+
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
|
|
1384
|
+
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
|
|
1385
|
+
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
|
|
1386
|
+
"TARGETING_TYPE_ENVIRONMENT",
|
|
1387
|
+
"TARGETING_TYPE_CARRIER_AND_ISP",
|
|
1388
|
+
"TARGETING_TYPE_OPERATING_SYSTEM",
|
|
1389
|
+
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
|
|
1390
|
+
"TARGETING_TYPE_KEYWORD",
|
|
1391
|
+
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
|
|
1392
|
+
"TARGETING_TYPE_VIEWABILITY",
|
|
1393
|
+
"TARGETING_TYPE_CATEGORY",
|
|
1394
|
+
"TARGETING_TYPE_INVENTORY_SOURCE",
|
|
1395
|
+
"TARGETING_TYPE_LANGUAGE",
|
|
1396
|
+
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
|
|
1397
|
+
"TARGETING_TYPE_GEO_REGION",
|
|
1398
|
+
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
|
|
1399
|
+
"TARGETING_TYPE_EXCHANGE",
|
|
1400
|
+
"TARGETING_TYPE_SUB_EXCHANGE",
|
|
1401
|
+
"TARGETING_TYPE_POI",
|
|
1402
|
+
"TARGETING_TYPE_BUSINESS_CHAIN",
|
|
1403
|
+
"TARGETING_TYPE_CONTENT_DURATION",
|
|
1404
|
+
"TARGETING_TYPE_CONTENT_STREAM_TYPE",
|
|
1405
|
+
"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
|
|
1406
|
+
"TARGETING_TYPE_OMID",
|
|
1407
|
+
"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
|
|
1408
|
+
"TARGETING_TYPE_CONTENT_GENRE",
|
|
1409
|
+
"TARGETING_TYPE_YOUTUBE_VIDEO",
|
|
1410
|
+
"TARGETING_TYPE_YOUTUBE_CHANNEL",
|
|
1411
|
+
"TARGETING_TYPE_SESSION_POSITION",
|
|
1412
|
+
"TARGETING_TYPE_CONTENT_THEME_EXCLUSION"
|
|
1413
|
+
],
|
|
1414
|
+
"enumDescriptions": [
|
|
1415
|
+
"Default value when type is not specified or is unknown in this version.",
|
|
1416
|
+
"Target a channel (a custom group of related websites or apps).",
|
|
1417
|
+
"Target an app category (for example, education or puzzle games).",
|
|
1418
|
+
"Target a specific app (for example, Angry Birds).",
|
|
1419
|
+
"Target a specific url (for example, quora.com).",
|
|
1420
|
+
"Target ads during a chosen time period on a specific day.",
|
|
1421
|
+
"Target ads to a specific age range (for example, 18-24).",
|
|
1422
|
+
"Target ads to the specified regions on a regional location list.",
|
|
1423
|
+
"Target ads to the specified points of interest on a proximity location list.",
|
|
1424
|
+
"Target ads to a specific gender (for example, female or male).",
|
|
1425
|
+
"Target a specific video player size for video ads.",
|
|
1426
|
+
"Target user rewarded content for video ads.",
|
|
1427
|
+
"Target ads to a specific parental status (for example, parent or not a parent).",
|
|
1428
|
+
"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
|
|
1429
|
+
"Target ads in a specific content outstream position.",
|
|
1430
|
+
"Target ads to a specific device type (for example, tablet or connected TV).",
|
|
1431
|
+
"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
|
|
1432
|
+
"Target ads to specific web browsers (for example, Chrome).",
|
|
1433
|
+
"Target ads to a specific household income range (for example, top 10%).",
|
|
1434
|
+
"Target ads in a specific on screen position.",
|
|
1435
|
+
"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
|
|
1436
|
+
"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
|
|
1437
|
+
"Filter website content by sensitive categories (for example, adult).",
|
|
1438
|
+
"Target ads to a specific environment (for example, web or app).",
|
|
1439
|
+
"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
|
|
1440
|
+
"Target ads to a specific operating system (for example, macOS).",
|
|
1441
|
+
"Target ads to a specific device make or model (for example, Roku or Samsung).",
|
|
1442
|
+
"Target ads to a specific keyword (for example, dog or retriever).",
|
|
1443
|
+
"Target ads to a specific negative keyword list.",
|
|
1444
|
+
"Target ads to a specific viewability (for example, 80% viewable).",
|
|
1445
|
+
"Target ads to a specific content category (for example, arts & entertainment).",
|
|
1446
|
+
"Purchase impressions from specific deals and auction packages.",
|
|
1447
|
+
"Target ads to a specific language (for example, English or Japanese).",
|
|
1448
|
+
"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
|
|
1449
|
+
"Target ads to a specific regional location (for example, a city or state).",
|
|
1450
|
+
"Purchase impressions from a group of deals and auction packages.",
|
|
1451
|
+
"Purchase impressions from specific exchanges.",
|
|
1452
|
+
"Purchase impressions from specific sub-exchanges.",
|
|
1453
|
+
"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
|
|
1454
|
+
"Target ads around locations of a business chain within a specific geo region.",
|
|
1455
|
+
"Target ads to a specific video content duration.",
|
|
1456
|
+
"Target ads to a specific video content stream type.",
|
|
1457
|
+
"Target ads to a specific native content position.",
|
|
1458
|
+
"Target ads in an Open Measurement enabled inventory.",
|
|
1459
|
+
"Target ads to a specific audio content type.",
|
|
1460
|
+
"Target ads to a specific content genre.",
|
|
1461
|
+
"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
|
|
1462
|
+
"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
|
|
1463
|
+
"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.",
|
|
1464
|
+
"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources."
|
|
1465
|
+
],
|
|
1466
|
+
"location": "path",
|
|
1467
|
+
"pattern": "^[^/]+$",
|
|
1468
|
+
"required": true,
|
|
1469
|
+
"type": "string"
|
|
1470
|
+
}
|
|
1471
|
+
},
|
|
1472
|
+
"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
|
|
1473
|
+
"response": {
|
|
1474
|
+
"$ref": "ListAdGroupAssignedTargetingOptionsResponse"
|
|
1475
|
+
},
|
|
1476
|
+
"scopes": [
|
|
1477
|
+
"https://www.googleapis.com/auth/display-video"
|
|
1478
|
+
]
|
|
1479
|
+
}
|
|
1480
|
+
}
|
|
1481
|
+
}
|
|
1482
|
+
}
|
|
1483
|
+
}
|
|
1484
|
+
}
|
|
1485
|
+
},
|
|
1486
|
+
"assets": {
|
|
1487
|
+
"methods": {
|
|
1488
|
+
"upload": {
|
|
1489
|
+
"description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).",
|
|
1490
|
+
"flatPath": "v3/advertisers/{advertisersId}/assets",
|
|
1491
|
+
"httpMethod": "POST",
|
|
1492
|
+
"id": "displayvideo.advertisers.assets.upload",
|
|
1493
|
+
"mediaUpload": {
|
|
1494
|
+
"accept": [
|
|
1495
|
+
"*/*"
|
|
1496
|
+
],
|
|
1497
|
+
"protocols": {
|
|
1498
|
+
"simple": {
|
|
1499
|
+
"multipart": true,
|
|
1500
|
+
"path": "/upload/v3/advertisers/{+advertiserId}/assets"
|
|
1501
|
+
}
|
|
1502
|
+
}
|
|
1503
|
+
},
|
|
1504
|
+
"parameterOrder": [
|
|
1505
|
+
"advertiserId"
|
|
1506
|
+
],
|
|
1507
|
+
"parameters": {
|
|
1508
|
+
"advertiserId": {
|
|
1509
|
+
"description": "Required. The ID of the advertiser this asset belongs to.",
|
|
1510
|
+
"format": "int64",
|
|
1511
|
+
"location": "path",
|
|
1512
|
+
"pattern": "^[^/]+$",
|
|
1513
|
+
"required": true,
|
|
1514
|
+
"type": "string"
|
|
1515
|
+
}
|
|
1516
|
+
},
|
|
1517
|
+
"path": "v3/advertisers/{+advertiserId}/assets",
|
|
1518
|
+
"request": {
|
|
1519
|
+
"$ref": "CreateAssetRequest"
|
|
1520
|
+
},
|
|
1521
|
+
"response": {
|
|
1522
|
+
"$ref": "CreateAssetResponse"
|
|
1523
|
+
},
|
|
1524
|
+
"scopes": [
|
|
1525
|
+
"https://www.googleapis.com/auth/display-video"
|
|
1526
|
+
],
|
|
1527
|
+
"supportsMediaUpload": true
|
|
1528
|
+
}
|
|
1529
|
+
}
|
|
1530
|
+
},
|
|
1531
|
+
"campaigns": {
|
|
1532
|
+
"methods": {
|
|
1533
|
+
"create": {
|
|
1534
|
+
"description": "Creates a new campaign. Returns the newly created campaign if successful.",
|
|
1535
|
+
"flatPath": "v3/advertisers/{advertisersId}/campaigns",
|
|
1536
|
+
"httpMethod": "POST",
|
|
1537
|
+
"id": "displayvideo.advertisers.campaigns.create",
|
|
1538
|
+
"parameterOrder": [
|
|
1539
|
+
"advertiserId"
|
|
1540
|
+
],
|
|
1541
|
+
"parameters": {
|
|
1542
|
+
"advertiserId": {
|
|
1543
|
+
"description": "Output only. The unique ID of the advertiser the campaign belongs to.",
|
|
1544
|
+
"format": "int64",
|
|
1545
|
+
"location": "path",
|
|
1546
|
+
"pattern": "^[^/]+$",
|
|
1547
|
+
"required": true,
|
|
1548
|
+
"type": "string"
|
|
1549
|
+
}
|
|
1550
|
+
},
|
|
1551
|
+
"path": "v3/advertisers/{+advertiserId}/campaigns",
|
|
1552
|
+
"request": {
|
|
1553
|
+
"$ref": "Campaign"
|
|
1554
|
+
},
|
|
1555
|
+
"response": {
|
|
1556
|
+
"$ref": "Campaign"
|
|
1557
|
+
},
|
|
1558
|
+
"scopes": [
|
|
1559
|
+
"https://www.googleapis.com/auth/display-video",
|
|
1560
|
+
"https://www.googleapis.com/auth/display-video-mediaplanning"
|
|
1561
|
+
]
|
|
1562
|
+
},
|
|
1563
|
+
"delete": {
|
|
1564
|
+
"description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.",
|
|
1565
|
+
"flatPath": "v3/advertisers/{advertisersId}/campaigns/{campaignsId}",
|
|
1566
|
+
"httpMethod": "DELETE",
|
|
1567
|
+
"id": "displayvideo.advertisers.campaigns.delete",
|
|
1568
|
+
"parameterOrder": [
|
|
1569
|
+
"advertiserId",
|
|
1570
|
+
"campaignId"
|
|
1571
|
+
],
|
|
1572
|
+
"parameters": {
|
|
1573
|
+
"advertiserId": {
|
|
1574
|
+
"description": "The ID of the advertiser this campaign belongs to.",
|
|
1575
|
+
"format": "int64",
|
|
1576
|
+
"location": "path",
|
|
1577
|
+
"pattern": "^[^/]+$",
|
|
1578
|
+
"required": true,
|
|
1579
|
+
"type": "string"
|
|
1580
|
+
},
|
|
1581
|
+
"campaignId": {
|
|
1582
|
+
"description": "The ID of the campaign we need to delete.",
|
|
1583
|
+
"format": "int64",
|
|
1584
|
+
"location": "path",
|
|
1585
|
+
"pattern": "^[^/]+$",
|
|
1586
|
+
"required": true,
|
|
1587
|
+
"type": "string"
|
|
1588
|
+
}
|
|
1589
|
+
},
|
|
1590
|
+
"path": "v3/advertisers/{+advertiserId}/campaigns/{+campaignId}",
|
|
1591
|
+
"response": {
|
|
1592
|
+
"$ref": "Empty"
|
|
1593
|
+
},
|
|
1594
|
+
"scopes": [
|
|
1595
|
+
"https://www.googleapis.com/auth/display-video",
|
|
1596
|
+
"https://www.googleapis.com/auth/display-video-mediaplanning"
|
|
1047
1597
|
]
|
|
1048
1598
|
},
|
|
1049
1599
|
"get": {
|
|
@@ -8156,7 +8706,7 @@
|
|
|
8156
8706
|
}
|
|
8157
8707
|
}
|
|
8158
8708
|
},
|
|
8159
|
-
"revision": "
|
|
8709
|
+
"revision": "20260312",
|
|
8160
8710
|
"rootUrl": "https://displayvideo.googleapis.com/",
|
|
8161
8711
|
"schemas": {
|
|
8162
8712
|
"ActiveViewVideoViewabilityMetricConfig": {
|
|
@@ -8279,7 +8829,7 @@
|
|
|
8279
8829
|
"id": "AdGroup",
|
|
8280
8830
|
"properties": {
|
|
8281
8831
|
"adGroupFormat": {
|
|
8282
|
-
"description": "Required. The format of the ads in the ad group.",
|
|
8832
|
+
"description": "Required. Immutable. The format of the ads in the ad group.",
|
|
8283
8833
|
"enum": [
|
|
8284
8834
|
"AD_GROUP_FORMAT_UNSPECIFIED",
|
|
8285
8835
|
"AD_GROUP_FORMAT_IN_STREAM",
|
|
@@ -8289,7 +8839,8 @@
|
|
|
8289
8839
|
"AD_GROUP_FORMAT_AUDIO",
|
|
8290
8840
|
"AD_GROUP_FORMAT_RESPONSIVE",
|
|
8291
8841
|
"AD_GROUP_FORMAT_REACH",
|
|
8292
|
-
"AD_GROUP_FORMAT_MASTHEAD"
|
|
8842
|
+
"AD_GROUP_FORMAT_MASTHEAD",
|
|
8843
|
+
"AD_GROUP_FORMAT_DEMAND_GEN"
|
|
8293
8844
|
],
|
|
8294
8845
|
"enumDescriptions": [
|
|
8295
8846
|
"Format value is not specified or is unknown in this version.",
|
|
@@ -8300,7 +8851,8 @@
|
|
|
8300
8851
|
"Non-skippable in-stream audio ads.",
|
|
8301
8852
|
"Responsive ads.",
|
|
8302
8853
|
"[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.",
|
|
8303
|
-
"Masthead Ad that is surfaced on the top slot on the YouTube homepage."
|
|
8854
|
+
"Masthead Ad that is surfaced on the top slot on the YouTube homepage.",
|
|
8855
|
+
"Demand Gen ads."
|
|
8304
8856
|
],
|
|
8305
8857
|
"type": "string"
|
|
8306
8858
|
},
|
|
@@ -8310,6 +8862,10 @@
|
|
|
8310
8862
|
"readOnly": true,
|
|
8311
8863
|
"type": "string"
|
|
8312
8864
|
},
|
|
8865
|
+
"adGroupInventoryControl": {
|
|
8866
|
+
"$ref": "AdGroupInventoryControl",
|
|
8867
|
+
"description": "Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups."
|
|
8868
|
+
},
|
|
8313
8869
|
"advertiserId": {
|
|
8314
8870
|
"description": "Output only. The unique ID of the advertiser the ad group belongs to.",
|
|
8315
8871
|
"format": "int64",
|
|
@@ -8345,7 +8901,7 @@
|
|
|
8345
8901
|
"type": "string"
|
|
8346
8902
|
},
|
|
8347
8903
|
"lineItemId": {
|
|
8348
|
-
"description": "Required. The unique ID of the line item that the ad group belongs to.",
|
|
8904
|
+
"description": "Required. Immutable. The unique ID of the line item that the ad group belongs to.",
|
|
8349
8905
|
"format": "int64",
|
|
8350
8906
|
"type": "string"
|
|
8351
8907
|
},
|
|
@@ -8376,7 +8932,7 @@
|
|
|
8376
8932
|
"type": "string"
|
|
8377
8933
|
},
|
|
8378
8934
|
"adGroupId": {
|
|
8379
|
-
"description": "Required. The unique ID of the ad group that the ad belongs to.",
|
|
8935
|
+
"description": "Required. Immutable. The unique ID of the ad group that the ad belongs to.",
|
|
8380
8936
|
"format": "int64",
|
|
8381
8937
|
"type": "string"
|
|
8382
8938
|
},
|
|
@@ -8409,8 +8965,24 @@
|
|
|
8409
8965
|
"description": "Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.",
|
|
8410
8966
|
"readOnly": true
|
|
8411
8967
|
},
|
|
8412
|
-
"
|
|
8413
|
-
"
|
|
8968
|
+
"demandGenCarouselAd": {
|
|
8969
|
+
"$ref": "DemandGenCarouselAd",
|
|
8970
|
+
"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd)."
|
|
8971
|
+
},
|
|
8972
|
+
"demandGenImageAd": {
|
|
8973
|
+
"$ref": "DemandGenImageAd",
|
|
8974
|
+
"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd)."
|
|
8975
|
+
},
|
|
8976
|
+
"demandGenProductAd": {
|
|
8977
|
+
"$ref": "DemandGenProductAd",
|
|
8978
|
+
"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd)."
|
|
8979
|
+
},
|
|
8980
|
+
"demandGenVideoAd": {
|
|
8981
|
+
"$ref": "DemandGenVideoAd",
|
|
8982
|
+
"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd)."
|
|
8983
|
+
},
|
|
8984
|
+
"displayName": {
|
|
8985
|
+
"description": "Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.",
|
|
8414
8986
|
"type": "string"
|
|
8415
8987
|
},
|
|
8416
8988
|
"displayVideoSourceAd": {
|
|
@@ -8487,6 +9059,31 @@
|
|
|
8487
9059
|
},
|
|
8488
9060
|
"type": "object"
|
|
8489
9061
|
},
|
|
9062
|
+
"AdGroupInventoryControl": {
|
|
9063
|
+
"description": "The inventory control of the ad group.",
|
|
9064
|
+
"id": "AdGroupInventoryControl",
|
|
9065
|
+
"properties": {
|
|
9066
|
+
"adGroupInventoryStrategy": {
|
|
9067
|
+
"description": "The inventory strategy.",
|
|
9068
|
+
"enum": [
|
|
9069
|
+
"AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED",
|
|
9070
|
+
"AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY",
|
|
9071
|
+
"AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY"
|
|
9072
|
+
],
|
|
9073
|
+
"enumDescriptions": [
|
|
9074
|
+
"Not specified or unknown.",
|
|
9075
|
+
"The ad group is opted-in to all Google and Display Network inventory.",
|
|
9076
|
+
"The ad group is opted-in to all Google inventory."
|
|
9077
|
+
],
|
|
9078
|
+
"type": "string"
|
|
9079
|
+
},
|
|
9080
|
+
"selectedInventories": {
|
|
9081
|
+
"$ref": "SelectedInventories",
|
|
9082
|
+
"description": "The selected inventories."
|
|
9083
|
+
}
|
|
9084
|
+
},
|
|
9085
|
+
"type": "object"
|
|
9086
|
+
},
|
|
8490
9087
|
"AdPolicy": {
|
|
8491
9088
|
"description": "A single ad policy associated with an ad group ad.",
|
|
8492
9089
|
"id": "AdPolicy",
|
|
@@ -11150,6 +11747,10 @@
|
|
|
11150
11747
|
"description": "Settings that control the bid strategy. Bid strategy determines the bid price.",
|
|
11151
11748
|
"id": "BiddingStrategy",
|
|
11152
11749
|
"properties": {
|
|
11750
|
+
"demandGenBid": {
|
|
11751
|
+
"$ref": "DemandGenBiddingStrategy",
|
|
11752
|
+
"description": "A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity."
|
|
11753
|
+
},
|
|
11153
11754
|
"fixedBid": {
|
|
11154
11755
|
"$ref": "FixedBidStrategy",
|
|
11155
11756
|
"description": "A strategy that uses a fixed bid price."
|
|
@@ -11231,6 +11832,68 @@
|
|
|
11231
11832
|
},
|
|
11232
11833
|
"type": "object"
|
|
11233
11834
|
},
|
|
11835
|
+
"BulkEditAdGroupAssignedTargetingOptionsRequest": {
|
|
11836
|
+
"description": "Request message for BulkEditAdGroupAssignedTargetingOptions.",
|
|
11837
|
+
"id": "BulkEditAdGroupAssignedTargetingOptionsRequest",
|
|
11838
|
+
"properties": {
|
|
11839
|
+
"adGroupIds": {
|
|
11840
|
+
"description": "Required. The IDs of the ad groups the assigned targeting options will belong to. A maximum of 25 ad group IDs can be specified.",
|
|
11841
|
+
"items": {
|
|
11842
|
+
"format": "int64",
|
|
11843
|
+
"type": "string"
|
|
11844
|
+
},
|
|
11845
|
+
"type": "array"
|
|
11846
|
+
},
|
|
11847
|
+
"createRequests": {
|
|
11848
|
+
"description": "Optional. The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`",
|
|
11849
|
+
"items": {
|
|
11850
|
+
"$ref": "CreateAssignedTargetingOptionsRequest"
|
|
11851
|
+
},
|
|
11852
|
+
"type": "array"
|
|
11853
|
+
},
|
|
11854
|
+
"deleteRequests": {
|
|
11855
|
+
"description": "Optional. The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`",
|
|
11856
|
+
"items": {
|
|
11857
|
+
"$ref": "DeleteAssignedTargetingOptionsRequest"
|
|
11858
|
+
},
|
|
11859
|
+
"type": "array"
|
|
11860
|
+
}
|
|
11861
|
+
},
|
|
11862
|
+
"type": "object"
|
|
11863
|
+
},
|
|
11864
|
+
"BulkEditAdGroupAssignedTargetingOptionsResponse": {
|
|
11865
|
+
"description": "Response message for BulkEditAssignedTargetingOptions.",
|
|
11866
|
+
"id": "BulkEditAdGroupAssignedTargetingOptionsResponse",
|
|
11867
|
+
"properties": {
|
|
11868
|
+
"errors": {
|
|
11869
|
+
"description": "Output only. The error information for each ad group that failed to update.",
|
|
11870
|
+
"items": {
|
|
11871
|
+
"$ref": "Status"
|
|
11872
|
+
},
|
|
11873
|
+
"readOnly": true,
|
|
11874
|
+
"type": "array"
|
|
11875
|
+
},
|
|
11876
|
+
"failedAdGroupIds": {
|
|
11877
|
+
"description": "Output only. The IDs of the ad groups which failed to update.",
|
|
11878
|
+
"items": {
|
|
11879
|
+
"format": "int64",
|
|
11880
|
+
"type": "string"
|
|
11881
|
+
},
|
|
11882
|
+
"readOnly": true,
|
|
11883
|
+
"type": "array"
|
|
11884
|
+
},
|
|
11885
|
+
"updatedAdGroupIds": {
|
|
11886
|
+
"description": "Output only. The IDs of the ad groups which were successfully updated.",
|
|
11887
|
+
"items": {
|
|
11888
|
+
"format": "int64",
|
|
11889
|
+
"type": "string"
|
|
11890
|
+
},
|
|
11891
|
+
"readOnly": true,
|
|
11892
|
+
"type": "array"
|
|
11893
|
+
}
|
|
11894
|
+
},
|
|
11895
|
+
"type": "object"
|
|
11896
|
+
},
|
|
11234
11897
|
"BulkEditAdvertiserAssignedTargetingOptionsRequest": {
|
|
11235
11898
|
"description": "Request message for BulkEditAdvertiserAssignedTargetingOptions.",
|
|
11236
11899
|
"id": "BulkEditAdvertiserAssignedTargetingOptionsRequest",
|
|
@@ -11782,7 +12445,8 @@
|
|
|
11782
12445
|
"GEO_REGION_TYPE_QUARTER",
|
|
11783
12446
|
"GEO_REGION_TYPE_DIVISION",
|
|
11784
12447
|
"GEO_REGION_TYPE_COMMUNE",
|
|
11785
|
-
"GEO_REGION_TYPE_COLLOQUIAL_AREA"
|
|
12448
|
+
"GEO_REGION_TYPE_COLLOQUIAL_AREA",
|
|
12449
|
+
"GEO_REGION_TYPE_POST_TOWN"
|
|
11786
12450
|
],
|
|
11787
12451
|
"enumDescriptions": [
|
|
11788
12452
|
"The geographic region type is unknown.",
|
|
@@ -11822,7 +12486,8 @@
|
|
|
11822
12486
|
"The geographic region is a quarter.",
|
|
11823
12487
|
"The geographic region is a division.",
|
|
11824
12488
|
"The geographic region is a commune.",
|
|
11825
|
-
"The geographic region is a colloquial area."
|
|
12489
|
+
"The geographic region is a colloquial area.",
|
|
12490
|
+
"The geographic region is a post town."
|
|
11826
12491
|
],
|
|
11827
12492
|
"readOnly": true,
|
|
11828
12493
|
"type": "string"
|
|
@@ -12013,6 +12678,41 @@
|
|
|
12013
12678
|
},
|
|
12014
12679
|
"type": "object"
|
|
12015
12680
|
},
|
|
12681
|
+
"CarouselCard": {
|
|
12682
|
+
"description": "Details for a Demand Gen carousel card.",
|
|
12683
|
+
"id": "CarouselCard",
|
|
12684
|
+
"properties": {
|
|
12685
|
+
"callToAction": {
|
|
12686
|
+
"description": "Required. The call-to-action button shown on the card. Must use 10 characters or less.",
|
|
12687
|
+
"type": "string"
|
|
12688
|
+
},
|
|
12689
|
+
"finalMobileUrl": {
|
|
12690
|
+
"description": "Optional. The URL address of the webpage that people reach after they click the card on a mobile device.",
|
|
12691
|
+
"type": "string"
|
|
12692
|
+
},
|
|
12693
|
+
"finalUrl": {
|
|
12694
|
+
"description": "Required. The URL address of the webpage that people reach after they click the card.",
|
|
12695
|
+
"type": "string"
|
|
12696
|
+
},
|
|
12697
|
+
"headline": {
|
|
12698
|
+
"description": "Required. The headline of the card.",
|
|
12699
|
+
"type": "string"
|
|
12700
|
+
},
|
|
12701
|
+
"marketingImage": {
|
|
12702
|
+
"$ref": "ImageAsset",
|
|
12703
|
+
"description": "Optional. The marketing image shown on the card."
|
|
12704
|
+
},
|
|
12705
|
+
"portraitMarketingImage": {
|
|
12706
|
+
"$ref": "ImageAsset",
|
|
12707
|
+
"description": "Optional. The portrait marketing image shown on the card."
|
|
12708
|
+
},
|
|
12709
|
+
"squareMarketingImage": {
|
|
12710
|
+
"$ref": "ImageAsset",
|
|
12711
|
+
"description": "Optional. The square marketing image shown on the card."
|
|
12712
|
+
}
|
|
12713
|
+
},
|
|
12714
|
+
"type": "object"
|
|
12715
|
+
},
|
|
12016
12716
|
"CarrierAndIspAssignedTargetingOptionDetails": {
|
|
12017
12717
|
"description": "Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.",
|
|
12018
12718
|
"id": "CarrierAndIspAssignedTargetingOptionDetails",
|
|
@@ -12804,6 +13504,11 @@
|
|
|
12804
13504
|
"description": "The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.",
|
|
12805
13505
|
"format": "int64",
|
|
12806
13506
|
"type": "string"
|
|
13507
|
+
},
|
|
13508
|
+
"primaryAttributionModelId": {
|
|
13509
|
+
"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.",
|
|
13510
|
+
"format": "int64",
|
|
13511
|
+
"type": "string"
|
|
12807
13512
|
}
|
|
12808
13513
|
},
|
|
12809
13514
|
"type": "object"
|
|
@@ -13030,9 +13735,9 @@ true,
|
|
|
13030
13735
|
true,
|
|
13031
13736
|
true,
|
|
13032
13737
|
true,
|
|
13033
|
-
|
|
13034
|
-
|
|
13035
|
-
|
|
13738
|
+
true,
|
|
13739
|
+
true,
|
|
13740
|
+
true,
|
|
13036
13741
|
false,
|
|
13037
13742
|
false,
|
|
13038
13743
|
false
|
|
@@ -13955,179 +14660,621 @@ false
|
|
|
13955
14660
|
},
|
|
13956
14661
|
"type": "object"
|
|
13957
14662
|
},
|
|
13958
|
-
"DayAndTimeAssignedTargetingOptionDetails": {
|
|
13959
|
-
"description": "Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.",
|
|
13960
|
-
"id": "DayAndTimeAssignedTargetingOptionDetails",
|
|
14663
|
+
"DayAndTimeAssignedTargetingOptionDetails": {
|
|
14664
|
+
"description": "Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.",
|
|
14665
|
+
"id": "DayAndTimeAssignedTargetingOptionDetails",
|
|
14666
|
+
"properties": {
|
|
14667
|
+
"dayOfWeek": {
|
|
14668
|
+
"description": "Required. The day of the week for this day and time targeting setting.",
|
|
14669
|
+
"enum": [
|
|
14670
|
+
"DAY_OF_WEEK_UNSPECIFIED",
|
|
14671
|
+
"MONDAY",
|
|
14672
|
+
"TUESDAY",
|
|
14673
|
+
"WEDNESDAY",
|
|
14674
|
+
"THURSDAY",
|
|
14675
|
+
"FRIDAY",
|
|
14676
|
+
"SATURDAY",
|
|
14677
|
+
"SUNDAY"
|
|
14678
|
+
],
|
|
14679
|
+
"enumDescriptions": [
|
|
14680
|
+
"The day of the week is unspecified.",
|
|
14681
|
+
"Monday",
|
|
14682
|
+
"Tuesday",
|
|
14683
|
+
"Wednesday",
|
|
14684
|
+
"Thursday",
|
|
14685
|
+
"Friday",
|
|
14686
|
+
"Saturday",
|
|
14687
|
+
"Sunday"
|
|
14688
|
+
],
|
|
14689
|
+
"type": "string"
|
|
14690
|
+
},
|
|
14691
|
+
"endHour": {
|
|
14692
|
+
"description": "Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).",
|
|
14693
|
+
"format": "int32",
|
|
14694
|
+
"type": "integer"
|
|
14695
|
+
},
|
|
14696
|
+
"startHour": {
|
|
14697
|
+
"description": "Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).",
|
|
14698
|
+
"format": "int32",
|
|
14699
|
+
"type": "integer"
|
|
14700
|
+
},
|
|
14701
|
+
"timeZoneResolution": {
|
|
14702
|
+
"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.",
|
|
14703
|
+
"enum": [
|
|
14704
|
+
"TIME_ZONE_RESOLUTION_UNSPECIFIED",
|
|
14705
|
+
"TIME_ZONE_RESOLUTION_END_USER",
|
|
14706
|
+
"TIME_ZONE_RESOLUTION_ADVERTISER"
|
|
14707
|
+
],
|
|
14708
|
+
"enumDescriptions": [
|
|
14709
|
+
"Time zone resolution is either unspecific or unknown.",
|
|
14710
|
+
"Times are resolved in the time zone of the user that saw the ad.",
|
|
14711
|
+
"Times are resolved in the time zone of the advertiser that served the ad."
|
|
14712
|
+
],
|
|
14713
|
+
"type": "string"
|
|
14714
|
+
}
|
|
14715
|
+
},
|
|
14716
|
+
"type": "object"
|
|
14717
|
+
},
|
|
14718
|
+
"DeleteAssignedTargetingOptionsRequest": {
|
|
14719
|
+
"description": "A request listing which assigned targeting options of a given targeting type should be deleted.",
|
|
14720
|
+
"id": "DeleteAssignedTargetingOptionsRequest",
|
|
14721
|
+
"properties": {
|
|
14722
|
+
"assignedTargetingOptionIds": {
|
|
14723
|
+
"description": "Required. The assigned targeting option IDs to delete.",
|
|
14724
|
+
"items": {
|
|
14725
|
+
"type": "string"
|
|
14726
|
+
},
|
|
14727
|
+
"type": "array"
|
|
14728
|
+
},
|
|
14729
|
+
"targetingType": {
|
|
14730
|
+
"description": "Required. Identifies the type of this assigned targeting option.",
|
|
14731
|
+
"enum": [
|
|
14732
|
+
"TARGETING_TYPE_UNSPECIFIED",
|
|
14733
|
+
"TARGETING_TYPE_CHANNEL",
|
|
14734
|
+
"TARGETING_TYPE_APP_CATEGORY",
|
|
14735
|
+
"TARGETING_TYPE_APP",
|
|
14736
|
+
"TARGETING_TYPE_URL",
|
|
14737
|
+
"TARGETING_TYPE_DAY_AND_TIME",
|
|
14738
|
+
"TARGETING_TYPE_AGE_RANGE",
|
|
14739
|
+
"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
|
|
14740
|
+
"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
|
|
14741
|
+
"TARGETING_TYPE_GENDER",
|
|
14742
|
+
"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
|
|
14743
|
+
"TARGETING_TYPE_USER_REWARDED_CONTENT",
|
|
14744
|
+
"TARGETING_TYPE_PARENTAL_STATUS",
|
|
14745
|
+
"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
|
|
14746
|
+
"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
|
|
14747
|
+
"TARGETING_TYPE_DEVICE_TYPE",
|
|
14748
|
+
"TARGETING_TYPE_AUDIENCE_GROUP",
|
|
14749
|
+
"TARGETING_TYPE_BROWSER",
|
|
14750
|
+
"TARGETING_TYPE_HOUSEHOLD_INCOME",
|
|
14751
|
+
"TARGETING_TYPE_ON_SCREEN_POSITION",
|
|
14752
|
+
"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
|
|
14753
|
+
"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
|
|
14754
|
+
"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
|
|
14755
|
+
"TARGETING_TYPE_ENVIRONMENT",
|
|
14756
|
+
"TARGETING_TYPE_CARRIER_AND_ISP",
|
|
14757
|
+
"TARGETING_TYPE_OPERATING_SYSTEM",
|
|
14758
|
+
"TARGETING_TYPE_DEVICE_MAKE_MODEL",
|
|
14759
|
+
"TARGETING_TYPE_KEYWORD",
|
|
14760
|
+
"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
|
|
14761
|
+
"TARGETING_TYPE_VIEWABILITY",
|
|
14762
|
+
"TARGETING_TYPE_CATEGORY",
|
|
14763
|
+
"TARGETING_TYPE_INVENTORY_SOURCE",
|
|
14764
|
+
"TARGETING_TYPE_LANGUAGE",
|
|
14765
|
+
"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
|
|
14766
|
+
"TARGETING_TYPE_GEO_REGION",
|
|
14767
|
+
"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
|
|
14768
|
+
"TARGETING_TYPE_EXCHANGE",
|
|
14769
|
+
"TARGETING_TYPE_SUB_EXCHANGE",
|
|
14770
|
+
"TARGETING_TYPE_POI",
|
|
14771
|
+
"TARGETING_TYPE_BUSINESS_CHAIN",
|
|
14772
|
+
"TARGETING_TYPE_CONTENT_DURATION",
|
|
14773
|
+
"TARGETING_TYPE_CONTENT_STREAM_TYPE",
|
|
14774
|
+
"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
|
|
14775
|
+
"TARGETING_TYPE_OMID",
|
|
14776
|
+
"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
|
|
14777
|
+
"TARGETING_TYPE_CONTENT_GENRE",
|
|
14778
|
+
"TARGETING_TYPE_YOUTUBE_VIDEO",
|
|
14779
|
+
"TARGETING_TYPE_YOUTUBE_CHANNEL",
|
|
14780
|
+
"TARGETING_TYPE_SESSION_POSITION",
|
|
14781
|
+
"TARGETING_TYPE_CONTENT_THEME_EXCLUSION"
|
|
14782
|
+
],
|
|
14783
|
+
"enumDescriptions": [
|
|
14784
|
+
"Default value when type is not specified or is unknown in this version.",
|
|
14785
|
+
"Target a channel (a custom group of related websites or apps).",
|
|
14786
|
+
"Target an app category (for example, education or puzzle games).",
|
|
14787
|
+
"Target a specific app (for example, Angry Birds).",
|
|
14788
|
+
"Target a specific url (for example, quora.com).",
|
|
14789
|
+
"Target ads during a chosen time period on a specific day.",
|
|
14790
|
+
"Target ads to a specific age range (for example, 18-24).",
|
|
14791
|
+
"Target ads to the specified regions on a regional location list.",
|
|
14792
|
+
"Target ads to the specified points of interest on a proximity location list.",
|
|
14793
|
+
"Target ads to a specific gender (for example, female or male).",
|
|
14794
|
+
"Target a specific video player size for video ads.",
|
|
14795
|
+
"Target user rewarded content for video ads.",
|
|
14796
|
+
"Target ads to a specific parental status (for example, parent or not a parent).",
|
|
14797
|
+
"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
|
|
14798
|
+
"Target ads in a specific content outstream position.",
|
|
14799
|
+
"Target ads to a specific device type (for example, tablet or connected TV).",
|
|
14800
|
+
"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
|
|
14801
|
+
"Target ads to specific web browsers (for example, Chrome).",
|
|
14802
|
+
"Target ads to a specific household income range (for example, top 10%).",
|
|
14803
|
+
"Target ads in a specific on screen position.",
|
|
14804
|
+
"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
|
|
14805
|
+
"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
|
|
14806
|
+
"Filter website content by sensitive categories (for example, adult).",
|
|
14807
|
+
"Target ads to a specific environment (for example, web or app).",
|
|
14808
|
+
"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
|
|
14809
|
+
"Target ads to a specific operating system (for example, macOS).",
|
|
14810
|
+
"Target ads to a specific device make or model (for example, Roku or Samsung).",
|
|
14811
|
+
"Target ads to a specific keyword (for example, dog or retriever).",
|
|
14812
|
+
"Target ads to a specific negative keyword list.",
|
|
14813
|
+
"Target ads to a specific viewability (for example, 80% viewable).",
|
|
14814
|
+
"Target ads to a specific content category (for example, arts & entertainment).",
|
|
14815
|
+
"Purchase impressions from specific deals and auction packages.",
|
|
14816
|
+
"Target ads to a specific language (for example, English or Japanese).",
|
|
14817
|
+
"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
|
|
14818
|
+
"Target ads to a specific regional location (for example, a city or state).",
|
|
14819
|
+
"Purchase impressions from a group of deals and auction packages.",
|
|
14820
|
+
"Purchase impressions from specific exchanges.",
|
|
14821
|
+
"Purchase impressions from specific sub-exchanges.",
|
|
14822
|
+
"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
|
|
14823
|
+
"Target ads around locations of a business chain within a specific geo region.",
|
|
14824
|
+
"Target ads to a specific video content duration.",
|
|
14825
|
+
"Target ads to a specific video content stream type.",
|
|
14826
|
+
"Target ads to a specific native content position.",
|
|
14827
|
+
"Target ads in an Open Measurement enabled inventory.",
|
|
14828
|
+
"Target ads to a specific audio content type.",
|
|
14829
|
+
"Target ads to a specific content genre.",
|
|
14830
|
+
"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
|
|
14831
|
+
"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
|
|
14832
|
+
"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.",
|
|
14833
|
+
"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources."
|
|
14834
|
+
],
|
|
14835
|
+
"type": "string"
|
|
14836
|
+
}
|
|
14837
|
+
},
|
|
14838
|
+
"type": "object"
|
|
14839
|
+
},
|
|
14840
|
+
"DemandGenBiddingStrategy": {
|
|
14841
|
+
"description": "Settings that control the bid strategy for Demand Gen resources.",
|
|
14842
|
+
"id": "DemandGenBiddingStrategy",
|
|
14843
|
+
"properties": {
|
|
14844
|
+
"effectiveBiddingValue": {
|
|
14845
|
+
"description": "Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.",
|
|
14846
|
+
"format": "int64",
|
|
14847
|
+
"readOnly": true,
|
|
14848
|
+
"type": "string"
|
|
14849
|
+
},
|
|
14850
|
+
"effectiveBiddingValueSource": {
|
|
14851
|
+
"description": "Output only. Source of the effective bidding value.",
|
|
14852
|
+
"enum": [
|
|
14853
|
+
"BIDDING_SOURCE_UNSPECIFIED",
|
|
14854
|
+
"BIDDING_SOURCE_LINE_ITEM",
|
|
14855
|
+
"BIDDING_SOURCE_AD_GROUP"
|
|
14856
|
+
],
|
|
14857
|
+
"enumDescriptions": [
|
|
14858
|
+
"Bidding source is not specified or unknown.",
|
|
14859
|
+
"Bidding value is inherited from the line item.",
|
|
14860
|
+
"Bidding value is defined in the ad group."
|
|
14861
|
+
],
|
|
14862
|
+
"readOnly": true,
|
|
14863
|
+
"type": "string"
|
|
14864
|
+
},
|
|
14865
|
+
"type": {
|
|
14866
|
+
"description": "Optional. The type of the bidding strategy. This can only be set at the line item level.",
|
|
14867
|
+
"enum": [
|
|
14868
|
+
"DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED",
|
|
14869
|
+
"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA",
|
|
14870
|
+
"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS",
|
|
14871
|
+
"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS",
|
|
14872
|
+
"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE",
|
|
14873
|
+
"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS"
|
|
14874
|
+
],
|
|
14875
|
+
"enumDescriptions": [
|
|
14876
|
+
"Type is not specified or unknown.",
|
|
14877
|
+
"A bidding strategy that automatically optimizes conversions per dollar.",
|
|
14878
|
+
"A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).",
|
|
14879
|
+
"A bidding strategy that automatically maximizes number of conversions",
|
|
14880
|
+
"A bidding strategy that automatically maximizes revenue while spending your budget.",
|
|
14881
|
+
"A bidding strategy that automatically maximizes clicks within a given budget."
|
|
14882
|
+
],
|
|
14883
|
+
"type": "string"
|
|
14884
|
+
},
|
|
14885
|
+
"value": {
|
|
14886
|
+
"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.",
|
|
14887
|
+
"format": "int64",
|
|
14888
|
+
"type": "string"
|
|
14889
|
+
}
|
|
14890
|
+
},
|
|
14891
|
+
"type": "object"
|
|
14892
|
+
},
|
|
14893
|
+
"DemandGenCarouselAd": {
|
|
14894
|
+
"description": "Details for a Demand Gen carousel ad.",
|
|
14895
|
+
"id": "DemandGenCarouselAd",
|
|
14896
|
+
"properties": {
|
|
14897
|
+
"businessName": {
|
|
14898
|
+
"description": "Required. The business name shown on the ad.",
|
|
14899
|
+
"type": "string"
|
|
14900
|
+
},
|
|
14901
|
+
"cards": {
|
|
14902
|
+
"description": "Required. The list of cards shown on the ad.",
|
|
14903
|
+
"items": {
|
|
14904
|
+
"$ref": "CarouselCard"
|
|
14905
|
+
},
|
|
14906
|
+
"type": "array"
|
|
14907
|
+
},
|
|
14908
|
+
"customParameters": {
|
|
14909
|
+
"additionalProperties": {
|
|
14910
|
+
"type": "string"
|
|
14911
|
+
},
|
|
14912
|
+
"description": "Optional. The custom parameters to pass custom values to tracking URL template.",
|
|
14913
|
+
"type": "object"
|
|
14914
|
+
},
|
|
14915
|
+
"description": {
|
|
14916
|
+
"description": "Required. The description of the ad.",
|
|
14917
|
+
"type": "string"
|
|
14918
|
+
},
|
|
14919
|
+
"finalUrl": {
|
|
14920
|
+
"description": "Required. The URL address of the webpage that people reach after they click the ad.",
|
|
14921
|
+
"type": "string"
|
|
14922
|
+
},
|
|
14923
|
+
"finalUrlSuffix": {
|
|
14924
|
+
"description": "Optional. The suffix to append to landing page URLs.",
|
|
14925
|
+
"type": "string"
|
|
14926
|
+
},
|
|
14927
|
+
"headline": {
|
|
14928
|
+
"description": "Required. The headline of the ad.",
|
|
14929
|
+
"type": "string"
|
|
14930
|
+
},
|
|
14931
|
+
"logo": {
|
|
14932
|
+
"$ref": "ImageAsset",
|
|
14933
|
+
"description": "Required. The logo image used by this ad."
|
|
14934
|
+
},
|
|
14935
|
+
"trackingUrl": {
|
|
14936
|
+
"description": "Output only. The URL address loaded in the background for tracking purposes.",
|
|
14937
|
+
"readOnly": true,
|
|
14938
|
+
"type": "string"
|
|
14939
|
+
},
|
|
14940
|
+
"userSpecifiedTrackingUrl": {
|
|
14941
|
+
"description": "Optional. The tracking URL specified by the user manually.",
|
|
14942
|
+
"type": "string"
|
|
14943
|
+
}
|
|
14944
|
+
},
|
|
14945
|
+
"type": "object"
|
|
14946
|
+
},
|
|
14947
|
+
"DemandGenImageAd": {
|
|
14948
|
+
"description": "Details for a Demand Gen image ad.",
|
|
14949
|
+
"id": "DemandGenImageAd",
|
|
14950
|
+
"properties": {
|
|
14951
|
+
"businessName": {
|
|
14952
|
+
"description": "Required. The business name shown on the ad.",
|
|
14953
|
+
"type": "string"
|
|
14954
|
+
},
|
|
14955
|
+
"callToAction": {
|
|
14956
|
+
"description": "Required. The call-to-action button shown on the ad.",
|
|
14957
|
+
"type": "string"
|
|
14958
|
+
},
|
|
14959
|
+
"customParameters": {
|
|
14960
|
+
"additionalProperties": {
|
|
14961
|
+
"type": "string"
|
|
14962
|
+
},
|
|
14963
|
+
"description": "Optional. The custom parameters to pass custom values to tracking URL template.",
|
|
14964
|
+
"type": "object"
|
|
14965
|
+
},
|
|
14966
|
+
"descriptions": {
|
|
14967
|
+
"description": "Required. The list of descriptions shown on the ad.",
|
|
14968
|
+
"items": {
|
|
14969
|
+
"type": "string"
|
|
14970
|
+
},
|
|
14971
|
+
"type": "array"
|
|
14972
|
+
},
|
|
14973
|
+
"finalMobileUrl": {
|
|
14974
|
+
"description": "Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.",
|
|
14975
|
+
"type": "string"
|
|
14976
|
+
},
|
|
14977
|
+
"finalUrl": {
|
|
14978
|
+
"description": "Required. The URL address of the webpage that people reach after they click the ad.",
|
|
14979
|
+
"type": "string"
|
|
14980
|
+
},
|
|
14981
|
+
"finalUrlSuffix": {
|
|
14982
|
+
"description": "Optional. The suffix to append to landing page URLs.",
|
|
14983
|
+
"type": "string"
|
|
14984
|
+
},
|
|
14985
|
+
"headlines": {
|
|
14986
|
+
"description": "Required. The list of headlines shown on the ad.",
|
|
14987
|
+
"items": {
|
|
14988
|
+
"type": "string"
|
|
14989
|
+
},
|
|
14990
|
+
"type": "array"
|
|
14991
|
+
},
|
|
14992
|
+
"logoImages": {
|
|
14993
|
+
"description": "The list of logo images shown on the ad.",
|
|
14994
|
+
"items": {
|
|
14995
|
+
"$ref": "ImageAsset"
|
|
14996
|
+
},
|
|
14997
|
+
"type": "array"
|
|
14998
|
+
},
|
|
14999
|
+
"marketingImages": {
|
|
15000
|
+
"description": "The list of marketing images shown on the ad.",
|
|
15001
|
+
"items": {
|
|
15002
|
+
"$ref": "ImageAsset"
|
|
15003
|
+
},
|
|
15004
|
+
"type": "array"
|
|
15005
|
+
},
|
|
15006
|
+
"portraitMarketingImages": {
|
|
15007
|
+
"description": "The list of portrait marketing images shown on the ad.",
|
|
15008
|
+
"items": {
|
|
15009
|
+
"$ref": "ImageAsset"
|
|
15010
|
+
},
|
|
15011
|
+
"type": "array"
|
|
15012
|
+
},
|
|
15013
|
+
"squareMarketingImages": {
|
|
15014
|
+
"description": "The list of square marketing images shown on the ad.",
|
|
15015
|
+
"items": {
|
|
15016
|
+
"$ref": "ImageAsset"
|
|
15017
|
+
},
|
|
15018
|
+
"type": "array"
|
|
15019
|
+
},
|
|
15020
|
+
"trackingUrl": {
|
|
15021
|
+
"description": "Output only. The URL address loaded in the background for tracking purposes.",
|
|
15022
|
+
"readOnly": true,
|
|
15023
|
+
"type": "string"
|
|
15024
|
+
},
|
|
15025
|
+
"userSpecifiedTrackingUrl": {
|
|
15026
|
+
"description": "Optional. The tracking URL specified by the user manually.",
|
|
15027
|
+
"type": "string"
|
|
15028
|
+
}
|
|
15029
|
+
},
|
|
15030
|
+
"type": "object"
|
|
15031
|
+
},
|
|
15032
|
+
"DemandGenProductAd": {
|
|
15033
|
+
"description": "Details for a Demand Gen product ad.",
|
|
15034
|
+
"id": "DemandGenProductAd",
|
|
15035
|
+
"properties": {
|
|
15036
|
+
"businessName": {
|
|
15037
|
+
"description": "Required. The business name shown on the ad.",
|
|
15038
|
+
"type": "string"
|
|
15039
|
+
},
|
|
15040
|
+
"callToAction": {
|
|
15041
|
+
"description": "Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`",
|
|
15042
|
+
"enum": [
|
|
15043
|
+
"CALL_TO_ACTION_UNSPECIFIED",
|
|
15044
|
+
"AUTOMATED",
|
|
15045
|
+
"LEARN_MORE",
|
|
15046
|
+
"GET_QUOTE",
|
|
15047
|
+
"APPLY_NOW",
|
|
15048
|
+
"SIGN_UP",
|
|
15049
|
+
"CONTACT_US",
|
|
15050
|
+
"SUBSCRIBE",
|
|
15051
|
+
"DOWNLOAD",
|
|
15052
|
+
"BOOK_NOW",
|
|
15053
|
+
"SHOP_NOW",
|
|
15054
|
+
"BUY_NOW",
|
|
15055
|
+
"DONATE_NOW",
|
|
15056
|
+
"ORDER_NOW",
|
|
15057
|
+
"PLAY_NOW",
|
|
15058
|
+
"SEE_MORE",
|
|
15059
|
+
"START_NOW",
|
|
15060
|
+
"VISIT_SITE",
|
|
15061
|
+
"WATCH_NOW"
|
|
15062
|
+
],
|
|
15063
|
+
"enumDescriptions": [
|
|
15064
|
+
"Not specified or unknown.",
|
|
15065
|
+
"Automated.",
|
|
15066
|
+
"Learn more.",
|
|
15067
|
+
"Get quote.",
|
|
15068
|
+
"Apply now.",
|
|
15069
|
+
"Sign up.",
|
|
15070
|
+
"Contact us.",
|
|
15071
|
+
"Subscribe.",
|
|
15072
|
+
"Download.",
|
|
15073
|
+
"Book now.",
|
|
15074
|
+
"Shop now.",
|
|
15075
|
+
"Buy now.",
|
|
15076
|
+
"Donate now.",
|
|
15077
|
+
"Order now.",
|
|
15078
|
+
"Play now.",
|
|
15079
|
+
"See more.",
|
|
15080
|
+
"Start now.",
|
|
15081
|
+
"Visit site.",
|
|
15082
|
+
"Watch now."
|
|
15083
|
+
],
|
|
15084
|
+
"type": "string"
|
|
15085
|
+
},
|
|
15086
|
+
"customParameters": {
|
|
15087
|
+
"additionalProperties": {
|
|
15088
|
+
"type": "string"
|
|
15089
|
+
},
|
|
15090
|
+
"description": "Optional. The custom parameters to pass custom values to tracking URL template.",
|
|
15091
|
+
"type": "object"
|
|
15092
|
+
},
|
|
15093
|
+
"description": {
|
|
15094
|
+
"description": "Required. The description of the ad.",
|
|
15095
|
+
"type": "string"
|
|
15096
|
+
},
|
|
15097
|
+
"displayUrlBreadcrumb1": {
|
|
15098
|
+
"description": "Optional. The first piece after the domain in the display URL.",
|
|
15099
|
+
"type": "string"
|
|
15100
|
+
},
|
|
15101
|
+
"displayUrlBreadcrumb2": {
|
|
15102
|
+
"description": "Optional. The second piece after the domain in the display URL.",
|
|
15103
|
+
"type": "string"
|
|
15104
|
+
},
|
|
15105
|
+
"finalUrl": {
|
|
15106
|
+
"description": "Required. The URL address of the webpage that people reach after they click the ad.",
|
|
15107
|
+
"type": "string"
|
|
15108
|
+
},
|
|
15109
|
+
"finalUrlSuffix": {
|
|
15110
|
+
"description": "Optional. The suffix to append to landing page URLs.",
|
|
15111
|
+
"type": "string"
|
|
15112
|
+
},
|
|
15113
|
+
"headline": {
|
|
15114
|
+
"description": "Required. The headline of the ad.",
|
|
15115
|
+
"type": "string"
|
|
15116
|
+
},
|
|
15117
|
+
"logo": {
|
|
15118
|
+
"$ref": "ImageAsset",
|
|
15119
|
+
"description": "Required. The logo image used by this ad."
|
|
15120
|
+
},
|
|
15121
|
+
"trackingUrl": {
|
|
15122
|
+
"description": "Output only. The URL address loaded in the background for tracking purposes.",
|
|
15123
|
+
"readOnly": true,
|
|
15124
|
+
"type": "string"
|
|
15125
|
+
},
|
|
15126
|
+
"userSpecifiedTrackingUrl": {
|
|
15127
|
+
"description": "Optional. The tracking URL specified by the user manually.",
|
|
15128
|
+
"type": "string"
|
|
15129
|
+
}
|
|
15130
|
+
},
|
|
15131
|
+
"type": "object"
|
|
15132
|
+
},
|
|
15133
|
+
"DemandGenSettings": {
|
|
15134
|
+
"description": "Settings for Demand Gen line items.",
|
|
15135
|
+
"id": "DemandGenSettings",
|
|
13961
15136
|
"properties": {
|
|
13962
|
-
"
|
|
13963
|
-
"description": "
|
|
13964
|
-
"
|
|
13965
|
-
|
|
13966
|
-
"
|
|
13967
|
-
"
|
|
13968
|
-
"
|
|
13969
|
-
"THURSDAY",
|
|
13970
|
-
"FRIDAY",
|
|
13971
|
-
"SATURDAY",
|
|
13972
|
-
"SUNDAY"
|
|
13973
|
-
],
|
|
13974
|
-
"enumDescriptions": [
|
|
13975
|
-
"The day of the week is unspecified.",
|
|
13976
|
-
"Monday",
|
|
13977
|
-
"Tuesday",
|
|
13978
|
-
"Wednesday",
|
|
13979
|
-
"Thursday",
|
|
13980
|
-
"Friday",
|
|
13981
|
-
"Saturday",
|
|
13982
|
-
"Sunday"
|
|
13983
|
-
],
|
|
15137
|
+
"geoLanguageTargetingEnabled": {
|
|
15138
|
+
"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups.",
|
|
15139
|
+
"type": "boolean"
|
|
15140
|
+
},
|
|
15141
|
+
"linkedMerchantId": {
|
|
15142
|
+
"description": "Optional. The ID of the merchant which is linked to the line item for product feed.",
|
|
15143
|
+
"format": "int64",
|
|
13984
15144
|
"type": "string"
|
|
13985
15145
|
},
|
|
13986
|
-
"
|
|
13987
|
-
"
|
|
13988
|
-
"
|
|
13989
|
-
|
|
15146
|
+
"thirdPartyMeasurementConfigs": {
|
|
15147
|
+
"$ref": "ThirdPartyMeasurementConfigs",
|
|
15148
|
+
"description": "Optional. The third party measurement settings for the Demand Gen line item."
|
|
15149
|
+
}
|
|
13990
15150
|
},
|
|
13991
|
-
"
|
|
13992
|
-
"description": "Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).",
|
|
13993
|
-
"format": "int32",
|
|
13994
|
-
"type": "integer"
|
|
15151
|
+
"type": "object"
|
|
13995
15152
|
},
|
|
13996
|
-
"
|
|
13997
|
-
"description": "
|
|
15153
|
+
"DemandGenVideoAd": {
|
|
15154
|
+
"description": "Details for a Demand Gen video ad.",
|
|
15155
|
+
"id": "DemandGenVideoAd",
|
|
15156
|
+
"properties": {
|
|
15157
|
+
"businessName": {
|
|
15158
|
+
"description": "Required. The business name shown on the ad.",
|
|
15159
|
+
"type": "string"
|
|
15160
|
+
},
|
|
15161
|
+
"callToAction": {
|
|
15162
|
+
"description": "Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`",
|
|
13998
15163
|
"enum": [
|
|
13999
|
-
"
|
|
14000
|
-
"
|
|
14001
|
-
"
|
|
15164
|
+
"CALL_TO_ACTION_UNSPECIFIED",
|
|
15165
|
+
"AUTOMATED",
|
|
15166
|
+
"LEARN_MORE",
|
|
15167
|
+
"GET_QUOTE",
|
|
15168
|
+
"APPLY_NOW",
|
|
15169
|
+
"SIGN_UP",
|
|
15170
|
+
"CONTACT_US",
|
|
15171
|
+
"SUBSCRIBE",
|
|
15172
|
+
"DOWNLOAD",
|
|
15173
|
+
"BOOK_NOW",
|
|
15174
|
+
"SHOP_NOW",
|
|
15175
|
+
"BUY_NOW",
|
|
15176
|
+
"DONATE_NOW",
|
|
15177
|
+
"ORDER_NOW",
|
|
15178
|
+
"PLAY_NOW",
|
|
15179
|
+
"SEE_MORE",
|
|
15180
|
+
"START_NOW",
|
|
15181
|
+
"VISIT_SITE",
|
|
15182
|
+
"WATCH_NOW"
|
|
14002
15183
|
],
|
|
14003
15184
|
"enumDescriptions": [
|
|
14004
|
-
"
|
|
14005
|
-
"
|
|
14006
|
-
"
|
|
15185
|
+
"Not specified or unknown.",
|
|
15186
|
+
"Automated.",
|
|
15187
|
+
"Learn more.",
|
|
15188
|
+
"Get quote.",
|
|
15189
|
+
"Apply now.",
|
|
15190
|
+
"Sign up.",
|
|
15191
|
+
"Contact us.",
|
|
15192
|
+
"Subscribe.",
|
|
15193
|
+
"Download.",
|
|
15194
|
+
"Book now.",
|
|
15195
|
+
"Shop now.",
|
|
15196
|
+
"Buy now.",
|
|
15197
|
+
"Donate now.",
|
|
15198
|
+
"Order now.",
|
|
15199
|
+
"Play now.",
|
|
15200
|
+
"See more.",
|
|
15201
|
+
"Start now.",
|
|
15202
|
+
"Visit site.",
|
|
15203
|
+
"Watch now."
|
|
14007
15204
|
],
|
|
14008
15205
|
"type": "string"
|
|
14009
|
-
}
|
|
14010
15206
|
},
|
|
15207
|
+
"companionBanner": {
|
|
15208
|
+
"$ref": "ImageAsset",
|
|
15209
|
+
"description": "Optional. The companion banner used by this ad."
|
|
15210
|
+
},
|
|
15211
|
+
"customParameters": {
|
|
15212
|
+
"additionalProperties": {
|
|
15213
|
+
"type": "string"
|
|
15214
|
+
},
|
|
15215
|
+
"description": "Optional. The custom parameters to pass custom values to tracking URL template.",
|
|
14011
15216
|
"type": "object"
|
|
14012
15217
|
},
|
|
14013
|
-
"
|
|
14014
|
-
"description": "
|
|
14015
|
-
"id": "DeleteAssignedTargetingOptionsRequest",
|
|
14016
|
-
"properties": {
|
|
14017
|
-
"assignedTargetingOptionIds": {
|
|
14018
|
-
"description": "Required. The assigned targeting option IDs to delete.",
|
|
15218
|
+
"descriptions": {
|
|
15219
|
+
"description": "Required. The list of descriptions shown on the ad.",
|
|
14019
15220
|
"items": {
|
|
14020
15221
|
"type": "string"
|
|
14021
15222
|
},
|
|
14022
15223
|
"type": "array"
|
|
14023
15224
|
},
|
|
14024
|
-
"
|
|
14025
|
-
"description": "
|
|
14026
|
-
"
|
|
14027
|
-
|
|
14028
|
-
"
|
|
14029
|
-
"
|
|
14030
|
-
"
|
|
14031
|
-
|
|
14032
|
-
"
|
|
14033
|
-
"
|
|
14034
|
-
"
|
|
14035
|
-
|
|
14036
|
-
"
|
|
14037
|
-
"
|
|
14038
|
-
"
|
|
14039
|
-
|
|
14040
|
-
"
|
|
14041
|
-
"
|
|
14042
|
-
"
|
|
14043
|
-
|
|
14044
|
-
"
|
|
14045
|
-
"
|
|
14046
|
-
"
|
|
14047
|
-
"
|
|
14048
|
-
|
|
14049
|
-
"
|
|
14050
|
-
|
|
14051
|
-
"
|
|
14052
|
-
"
|
|
14053
|
-
"
|
|
14054
|
-
|
|
14055
|
-
"
|
|
14056
|
-
"
|
|
14057
|
-
"
|
|
14058
|
-
"
|
|
14059
|
-
|
|
14060
|
-
"
|
|
14061
|
-
|
|
14062
|
-
"
|
|
14063
|
-
"
|
|
14064
|
-
"
|
|
14065
|
-
"
|
|
14066
|
-
|
|
14067
|
-
"
|
|
14068
|
-
"
|
|
14069
|
-
"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
|
|
14070
|
-
"TARGETING_TYPE_OMID",
|
|
14071
|
-
"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
|
|
14072
|
-
"TARGETING_TYPE_CONTENT_GENRE",
|
|
14073
|
-
"TARGETING_TYPE_YOUTUBE_VIDEO",
|
|
14074
|
-
"TARGETING_TYPE_YOUTUBE_CHANNEL",
|
|
14075
|
-
"TARGETING_TYPE_SESSION_POSITION",
|
|
14076
|
-
"TARGETING_TYPE_CONTENT_THEME_EXCLUSION"
|
|
14077
|
-
],
|
|
14078
|
-
"enumDescriptions": [
|
|
14079
|
-
"Default value when type is not specified or is unknown in this version.",
|
|
14080
|
-
"Target a channel (a custom group of related websites or apps).",
|
|
14081
|
-
"Target an app category (for example, education or puzzle games).",
|
|
14082
|
-
"Target a specific app (for example, Angry Birds).",
|
|
14083
|
-
"Target a specific url (for example, quora.com).",
|
|
14084
|
-
"Target ads during a chosen time period on a specific day.",
|
|
14085
|
-
"Target ads to a specific age range (for example, 18-24).",
|
|
14086
|
-
"Target ads to the specified regions on a regional location list.",
|
|
14087
|
-
"Target ads to the specified points of interest on a proximity location list.",
|
|
14088
|
-
"Target ads to a specific gender (for example, female or male).",
|
|
14089
|
-
"Target a specific video player size for video ads.",
|
|
14090
|
-
"Target user rewarded content for video ads.",
|
|
14091
|
-
"Target ads to a specific parental status (for example, parent or not a parent).",
|
|
14092
|
-
"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
|
|
14093
|
-
"Target ads in a specific content outstream position.",
|
|
14094
|
-
"Target ads to a specific device type (for example, tablet or connected TV).",
|
|
14095
|
-
"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
|
|
14096
|
-
"Target ads to specific web browsers (for example, Chrome).",
|
|
14097
|
-
"Target ads to a specific household income range (for example, top 10%).",
|
|
14098
|
-
"Target ads in a specific on screen position.",
|
|
14099
|
-
"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
|
|
14100
|
-
"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
|
|
14101
|
-
"Filter website content by sensitive categories (for example, adult).",
|
|
14102
|
-
"Target ads to a specific environment (for example, web or app).",
|
|
14103
|
-
"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
|
|
14104
|
-
"Target ads to a specific operating system (for example, macOS).",
|
|
14105
|
-
"Target ads to a specific device make or model (for example, Roku or Samsung).",
|
|
14106
|
-
"Target ads to a specific keyword (for example, dog or retriever).",
|
|
14107
|
-
"Target ads to a specific negative keyword list.",
|
|
14108
|
-
"Target ads to a specific viewability (for example, 80% viewable).",
|
|
14109
|
-
"Target ads to a specific content category (for example, arts & entertainment).",
|
|
14110
|
-
"Purchase impressions from specific deals and auction packages.",
|
|
14111
|
-
"Target ads to a specific language (for example, English or Japanese).",
|
|
14112
|
-
"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
|
|
14113
|
-
"Target ads to a specific regional location (for example, a city or state).",
|
|
14114
|
-
"Purchase impressions from a group of deals and auction packages.",
|
|
14115
|
-
"Purchase impressions from specific exchanges.",
|
|
14116
|
-
"Purchase impressions from specific sub-exchanges.",
|
|
14117
|
-
"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
|
|
14118
|
-
"Target ads around locations of a business chain within a specific geo region.",
|
|
14119
|
-
"Target ads to a specific video content duration.",
|
|
14120
|
-
"Target ads to a specific video content stream type.",
|
|
14121
|
-
"Target ads to a specific native content position.",
|
|
14122
|
-
"Target ads in an Open Measurement enabled inventory.",
|
|
14123
|
-
"Target ads to a specific audio content type.",
|
|
14124
|
-
"Target ads to a specific content genre.",
|
|
14125
|
-
"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
|
|
14126
|
-
"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
|
|
14127
|
-
"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.",
|
|
14128
|
-
"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources."
|
|
14129
|
-
],
|
|
15225
|
+
"displayUrlBreadcrumb1": {
|
|
15226
|
+
"description": "Optional. The first piece after the domain in the display URL.",
|
|
15227
|
+
"type": "string"
|
|
15228
|
+
},
|
|
15229
|
+
"displayUrlBreadcrumb2": {
|
|
15230
|
+
"description": "Optional. The second piece after the domain in the display URL.",
|
|
15231
|
+
"type": "string"
|
|
15232
|
+
},
|
|
15233
|
+
"finalMobileUrl": {
|
|
15234
|
+
"description": "Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.",
|
|
15235
|
+
"type": "string"
|
|
15236
|
+
},
|
|
15237
|
+
"finalUrl": {
|
|
15238
|
+
"description": "Required. The URL address of the webpage that people reach after they click the ad.",
|
|
15239
|
+
"type": "string"
|
|
15240
|
+
},
|
|
15241
|
+
"finalUrlSuffix": {
|
|
15242
|
+
"description": "Optional. The suffix to append to landing page URLs.",
|
|
15243
|
+
"type": "string"
|
|
15244
|
+
},
|
|
15245
|
+
"headlines": {
|
|
15246
|
+
"description": "Required. The list of headlines shown on the ad.",
|
|
15247
|
+
"items": {
|
|
15248
|
+
"type": "string"
|
|
15249
|
+
},
|
|
15250
|
+
"type": "array"
|
|
15251
|
+
},
|
|
15252
|
+
"logo": {
|
|
15253
|
+
"$ref": "ImageAsset",
|
|
15254
|
+
"description": "Required. The logo image used by this ad."
|
|
15255
|
+
},
|
|
15256
|
+
"longHeadlines": {
|
|
15257
|
+
"description": "Required. The list of lone headlines shown on the ad.",
|
|
15258
|
+
"items": {
|
|
15259
|
+
"type": "string"
|
|
15260
|
+
},
|
|
15261
|
+
"type": "array"
|
|
15262
|
+
},
|
|
15263
|
+
"trackingUrl": {
|
|
15264
|
+
"description": "Output only. The URL address loaded in the background for tracking purposes.",
|
|
15265
|
+
"readOnly": true,
|
|
15266
|
+
"type": "string"
|
|
15267
|
+
},
|
|
15268
|
+
"userSpecifiedTrackingUrl": {
|
|
15269
|
+
"description": "Optional. The tracking URL specified by the user manually.",
|
|
14130
15270
|
"type": "string"
|
|
15271
|
+
},
|
|
15272
|
+
"videos": {
|
|
15273
|
+
"description": "Required. The list of YouTube video assets used by this ad.",
|
|
15274
|
+
"items": {
|
|
15275
|
+
"$ref": "YoutubeVideoDetails"
|
|
15276
|
+
},
|
|
15277
|
+
"type": "array"
|
|
14131
15278
|
}
|
|
14132
15279
|
},
|
|
14133
15280
|
"type": "object"
|
|
@@ -16267,7 +17414,8 @@ false
|
|
|
16267
17414
|
"GEO_REGION_TYPE_QUARTER",
|
|
16268
17415
|
"GEO_REGION_TYPE_DIVISION",
|
|
16269
17416
|
"GEO_REGION_TYPE_COMMUNE",
|
|
16270
|
-
"GEO_REGION_TYPE_COLLOQUIAL_AREA"
|
|
17417
|
+
"GEO_REGION_TYPE_COLLOQUIAL_AREA",
|
|
17418
|
+
"GEO_REGION_TYPE_POST_TOWN"
|
|
16271
17419
|
],
|
|
16272
17420
|
"enumDescriptions": [
|
|
16273
17421
|
"The geographic region type is unknown.",
|
|
@@ -16307,7 +17455,8 @@ false
|
|
|
16307
17455
|
"The geographic region is a quarter.",
|
|
16308
17456
|
"The geographic region is a division.",
|
|
16309
17457
|
"The geographic region is a commune.",
|
|
16310
|
-
"The geographic region is a colloquial area."
|
|
17458
|
+
"The geographic region is a colloquial area.",
|
|
17459
|
+
"The geographic region is a post town."
|
|
16311
17460
|
],
|
|
16312
17461
|
"readOnly": true,
|
|
16313
17462
|
"type": "string"
|
|
@@ -16383,7 +17532,8 @@ false
|
|
|
16383
17532
|
"GEO_REGION_TYPE_QUARTER",
|
|
16384
17533
|
"GEO_REGION_TYPE_DIVISION",
|
|
16385
17534
|
"GEO_REGION_TYPE_COMMUNE",
|
|
16386
|
-
"GEO_REGION_TYPE_COLLOQUIAL_AREA"
|
|
17535
|
+
"GEO_REGION_TYPE_COLLOQUIAL_AREA",
|
|
17536
|
+
"GEO_REGION_TYPE_POST_TOWN"
|
|
16387
17537
|
],
|
|
16388
17538
|
"enumDescriptions": [
|
|
16389
17539
|
"The geographic region type is unknown.",
|
|
@@ -16423,7 +17573,8 @@ false
|
|
|
16423
17573
|
"The geographic region is a quarter.",
|
|
16424
17574
|
"The geographic region is a division.",
|
|
16425
17575
|
"The geographic region is a commune.",
|
|
16426
|
-
"The geographic region is a colloquial area."
|
|
17576
|
+
"The geographic region is a colloquial area.",
|
|
17577
|
+
"The geographic region is a post town."
|
|
16427
17578
|
],
|
|
16428
17579
|
"readOnly": true,
|
|
16429
17580
|
"type": "string"
|
|
@@ -16966,6 +18117,11 @@ false
|
|
|
16966
18117
|
"description": "Meta data of an image asset.",
|
|
16967
18118
|
"id": "ImageAsset",
|
|
16968
18119
|
"properties": {
|
|
18120
|
+
"assetId": {
|
|
18121
|
+
"description": "Required. The unique ID of the asset.",
|
|
18122
|
+
"format": "int64",
|
|
18123
|
+
"type": "string"
|
|
18124
|
+
},
|
|
16969
18125
|
"fileSize": {
|
|
16970
18126
|
"description": "Output only. File size of the image asset in bytes.",
|
|
16971
18127
|
"format": "int64",
|
|
@@ -17164,7 +18320,7 @@ false
|
|
|
17164
18320
|
"Insertion order automation option is not specified or is unknown in this version.",
|
|
17165
18321
|
"Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi. No automation on bid settings.",
|
|
17166
18322
|
"No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.",
|
|
17167
|
-
"Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by
|
|
18323
|
+
"Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by bid_strategy."
|
|
17168
18324
|
],
|
|
17169
18325
|
"type": "string"
|
|
17170
18326
|
},
|
|
@@ -18094,6 +19250,13 @@ false
|
|
|
18094
19250
|
"description": "Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`.",
|
|
18095
19251
|
"id": "KeywordAssignedTargetingOptionDetails",
|
|
18096
19252
|
"properties": {
|
|
19253
|
+
"exemptedPolicyNames": {
|
|
19254
|
+
"description": "Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.",
|
|
19255
|
+
"items": {
|
|
19256
|
+
"type": "string"
|
|
19257
|
+
},
|
|
19258
|
+
"type": "array"
|
|
19259
|
+
},
|
|
18097
19260
|
"keyword": {
|
|
18098
19261
|
"description": "Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.",
|
|
18099
19262
|
"type": "string"
|
|
@@ -18263,6 +19426,10 @@ false
|
|
|
18263
19426
|
},
|
|
18264
19427
|
"type": "array"
|
|
18265
19428
|
},
|
|
19429
|
+
"demandGenSettings": {
|
|
19430
|
+
"$ref": "DemandGenSettings",
|
|
19431
|
+
"description": "Optional. Settings specific to Demand Gen line items."
|
|
19432
|
+
},
|
|
18266
19433
|
"displayName": {
|
|
18267
19434
|
"description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.",
|
|
18268
19435
|
"type": "string"
|
|
@@ -18297,7 +19464,7 @@ false
|
|
|
18297
19464
|
},
|
|
18298
19465
|
"frequencyCap": {
|
|
18299
19466
|
"$ref": "FrequencyCap",
|
|
18300
|
-
"description": "
|
|
19467
|
+
"description": "Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN."
|
|
18301
19468
|
},
|
|
18302
19469
|
"insertionOrderId": {
|
|
18303
19470
|
"description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.",
|
|
@@ -18338,7 +19505,8 @@ false
|
|
|
18338
19505
|
"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY",
|
|
18339
19506
|
"LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW",
|
|
18340
19507
|
"LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME",
|
|
18341
|
-
"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME"
|
|
19508
|
+
"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME",
|
|
19509
|
+
"LINE_ITEM_TYPE_DEMAND_GEN"
|
|
18342
19510
|
],
|
|
18343
19511
|
"enumDescriptions": [
|
|
18344
19512
|
"Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.",
|
|
@@ -18362,7 +19530,8 @@ false
|
|
|
18362
19530
|
"The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.",
|
|
18363
19531
|
"YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.",
|
|
18364
19532
|
"Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.",
|
|
18365
|
-
"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API."
|
|
19533
|
+
"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.",
|
|
19534
|
+
"Demand Gen ads."
|
|
18366
19535
|
],
|
|
18367
19536
|
"type": "string"
|
|
18368
19537
|
},
|
|
@@ -18484,7 +19653,7 @@ false
|
|
|
18484
19653
|
"id": "LineItemBudget",
|
|
18485
19654
|
"properties": {
|
|
18486
19655
|
"budgetAllocationType": {
|
|
18487
|
-
"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.",
|
|
19656
|
+
"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types.",
|
|
18488
19657
|
"enum": [
|
|
18489
19658
|
"LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED",
|
|
18490
19659
|
"LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC",
|
|
@@ -20186,7 +21355,7 @@ false
|
|
|
20186
21355
|
"type": "string"
|
|
20187
21356
|
},
|
|
20188
21357
|
"markupType": {
|
|
20189
|
-
"description": "Required. The markup type of the partner revenue model.",
|
|
21358
|
+
"description": "Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`.",
|
|
20190
21359
|
"enum": [
|
|
20191
21360
|
"PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED",
|
|
20192
21361
|
"PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM",
|
|
@@ -20857,9 +22026,9 @@ true,
|
|
|
20857
22026
|
true,
|
|
20858
22027
|
true,
|
|
20859
22028
|
true,
|
|
20860
|
-
|
|
20861
|
-
|
|
20862
|
-
|
|
22029
|
+
true,
|
|
22030
|
+
true,
|
|
22031
|
+
true,
|
|
20863
22032
|
false,
|
|
20864
22033
|
false,
|
|
20865
22034
|
false
|
|
@@ -20952,9 +22121,9 @@ true,
|
|
|
20952
22121
|
true,
|
|
20953
22122
|
true,
|
|
20954
22123
|
true,
|
|
20955
|
-
|
|
20956
|
-
|
|
20957
|
-
|
|
22124
|
+
true,
|
|
22125
|
+
true,
|
|
22126
|
+
true,
|
|
20958
22127
|
false,
|
|
20959
22128
|
false,
|
|
20960
22129
|
false
|
|
@@ -21036,6 +22205,37 @@ false
|
|
|
21036
22205
|
},
|
|
21037
22206
|
"type": "object"
|
|
21038
22207
|
},
|
|
22208
|
+
"SelectedInventories": {
|
|
22209
|
+
"description": "The inventory control of the ad group.",
|
|
22210
|
+
"id": "SelectedInventories",
|
|
22211
|
+
"properties": {
|
|
22212
|
+
"allowDiscover": {
|
|
22213
|
+
"description": "Whether the ad group is opted-in to Discover inventory.",
|
|
22214
|
+
"type": "boolean"
|
|
22215
|
+
},
|
|
22216
|
+
"allowGmail": {
|
|
22217
|
+
"description": "Whether the ad group is opted-in to Gmail inventory.",
|
|
22218
|
+
"type": "boolean"
|
|
22219
|
+
},
|
|
22220
|
+
"allowGoogleDisplayNetwork": {
|
|
22221
|
+
"description": "Whether the ad group is opted-in to Google Display Network inventory.",
|
|
22222
|
+
"type": "boolean"
|
|
22223
|
+
},
|
|
22224
|
+
"allowYoutubeFeed": {
|
|
22225
|
+
"description": "Whether the ad group is opted-in to YouTube in-feed inventory.",
|
|
22226
|
+
"type": "boolean"
|
|
22227
|
+
},
|
|
22228
|
+
"allowYoutubeShorts": {
|
|
22229
|
+
"description": "Whether the ad group is opted-in to YouTube shorts inventory.",
|
|
22230
|
+
"type": "boolean"
|
|
22231
|
+
},
|
|
22232
|
+
"allowYoutubeStream": {
|
|
22233
|
+
"description": "Whether the ad group is opted-in to YouTube in-stream.",
|
|
22234
|
+
"type": "boolean"
|
|
22235
|
+
}
|
|
22236
|
+
},
|
|
22237
|
+
"type": "object"
|
|
22238
|
+
},
|
|
21039
22239
|
"SensitiveCategoryAssignedTargetingOptionDetails": {
|
|
21040
22240
|
"description": "Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.",
|
|
21041
22241
|
"id": "SensitiveCategoryAssignedTargetingOptionDetails",
|
|
@@ -21311,6 +22511,10 @@ false
|
|
|
21311
22511
|
"enableOptimizedTargeting": {
|
|
21312
22512
|
"description": "Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.",
|
|
21313
22513
|
"type": "boolean"
|
|
22514
|
+
},
|
|
22515
|
+
"excludeDemographicExpansion": {
|
|
22516
|
+
"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups.",
|
|
22517
|
+
"type": "boolean"
|
|
21314
22518
|
}
|
|
21315
22519
|
},
|
|
21316
22520
|
"type": "object"
|
|
@@ -21582,28 +22786,28 @@ false
|
|
|
21582
22786
|
"id": "ThirdPartyMeasurementConfigs",
|
|
21583
22787
|
"properties": {
|
|
21584
22788
|
"brandLiftVendorConfigs": {
|
|
21585
|
-
"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `
|
|
22789
|
+
"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`",
|
|
21586
22790
|
"items": {
|
|
21587
22791
|
"$ref": "ThirdPartyVendorConfig"
|
|
21588
22792
|
},
|
|
21589
22793
|
"type": "array"
|
|
21590
22794
|
},
|
|
21591
22795
|
"brandSafetyVendorConfigs": {
|
|
21592
|
-
"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `
|
|
22796
|
+
"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR`",
|
|
21593
22797
|
"items": {
|
|
21594
22798
|
"$ref": "ThirdPartyVendorConfig"
|
|
21595
22799
|
},
|
|
21596
22800
|
"type": "array"
|
|
21597
22801
|
},
|
|
21598
22802
|
"reachVendorConfigs": {
|
|
21599
|
-
"description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `
|
|
22803
|
+
"description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS`",
|
|
21600
22804
|
"items": {
|
|
21601
22805
|
"$ref": "ThirdPartyVendorConfig"
|
|
21602
22806
|
},
|
|
21603
22807
|
"type": "array"
|
|
21604
22808
|
},
|
|
21605
22809
|
"viewabilityVendorConfigs": {
|
|
21606
|
-
"description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`
|
|
22810
|
+
"description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`",
|
|
21607
22811
|
"items": {
|
|
21608
22812
|
"$ref": "ThirdPartyVendorConfig"
|
|
21609
22813
|
},
|
|
@@ -21696,7 +22900,16 @@ false
|
|
|
21696
22900
|
"THIRD_PARTY_VENDOR_NIELSEN",
|
|
21697
22901
|
"THIRD_PARTY_VENDOR_KANTAR",
|
|
21698
22902
|
"THIRD_PARTY_VENDOR_DYNATA",
|
|
21699
|
-
"THIRD_PARTY_VENDOR_TRANSUNION"
|
|
22903
|
+
"THIRD_PARTY_VENDOR_TRANSUNION",
|
|
22904
|
+
"THIRD_PARTY_VENDOR_ORIGIN",
|
|
22905
|
+
"THIRD_PARTY_VENDOR_GEMIUS",
|
|
22906
|
+
"THIRD_PARTY_VENDOR_MEDIA_SCOPE",
|
|
22907
|
+
"THIRD_PARTY_VENDOR_AUDIENCE_PROJECT",
|
|
22908
|
+
"THIRD_PARTY_VENDOR_VIDEO_AMP",
|
|
22909
|
+
"THIRD_PARTY_VENDOR_ISPOT_TV",
|
|
22910
|
+
"THIRD_PARTY_VENDOR_INTAGE",
|
|
22911
|
+
"THIRD_PARTY_VENDOR_MACROMILL",
|
|
22912
|
+
"THIRD_PARTY_VENDOR_VIDEO_RESEARCH"
|
|
21700
22913
|
],
|
|
21701
22914
|
"enumDescriptions": [
|
|
21702
22915
|
"Unknown third-party vendor.",
|
|
@@ -21710,7 +22923,16 @@ false
|
|
|
21710
22923
|
"Nielsen.",
|
|
21711
22924
|
"Kantar.",
|
|
21712
22925
|
"Dynata.",
|
|
21713
|
-
"Transunion."
|
|
22926
|
+
"Transunion.",
|
|
22927
|
+
"Origin.",
|
|
22928
|
+
"Gemius.",
|
|
22929
|
+
"MediaScope.",
|
|
22930
|
+
"Audience Project.",
|
|
22931
|
+
"Video Amp.",
|
|
22932
|
+
"Ispot TV.",
|
|
22933
|
+
"Intage.",
|
|
22934
|
+
"Macromill.",
|
|
22935
|
+
"Video Research."
|
|
21714
22936
|
],
|
|
21715
22937
|
"type": "string"
|
|
21716
22938
|
}
|