Api-Roll 54: 2017-09-11

discovery/googleapis/dfareporting__v2.8.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/ddmconversions": {
                     "description": "Manage DoubleClick Digital Marketing conversions"
                 },
                 "https://www.googleapis.com/auth/dfareporting": {
                     "description": "View and manage DoubleClick for Advertisers reports"
                 },
                 "https://www.googleapis.com/auth/dfatrafficking": {
                     "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
                 }
             }
         }
     },
     "basePath": "/dfareporting/v2.8/",
     "baseUrl": "https://www.googleapis.com/dfareporting/v2.8/",
-    "batchPath": "batch",
+    "batchPath": "batch/dfareporting/v2.8",
     "description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
     "discoveryVersion": "v1",
     "documentationLink": "https://developers.google.com/doubleclick-advertisers/",
-    "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/mDodB1FWVkZ2kJtHTr6oPPTc9mw\"",
+    "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/emGV_y_FRSYhyMgSPP7gVElVBpw\"",
     "icons": {
         "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
         "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
     },
     "id": "dfareporting:v2.8",
     "kind": "discovery#restDescription",
     "name": "dfareporting",
     "ownerDomain": "google.com",
     "ownerName": "Google",
     "parameters": {
@@ skipping 6614 matching lines @@
                             "type": "string"
                         },
                         "profileId": {
                             "description": "User profile ID associated with this request.",
                             "format": "int64",
                             "location": "path",
                             "required": true,
                             "type": "string"
                         },
                         "tagFormats": {
-                            "description": "Tag formats to generate for these placements.",
+                            "description": "Tag formats to generate for these placements.\n\nNote: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.",
                             "enum": [
                                 "PLACEMENT_TAG_CLICK_COMMANDS",
                                 "PLACEMENT_TAG_IFRAME_ILAYER",
                                 "PLACEMENT_TAG_IFRAME_JAVASCRIPT",
                                 "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY",
                                 "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH",
                                 "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3",
                                 "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4",
                                 "PLACEMENT_TAG_INTERNAL_REDIRECT",
                                 "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT",
@@ skipping 2760 matching lines @@
                     "response": {
                         "$ref": "VideoFormatsListResponse"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/dfatrafficking"
                     ]
                 }
             }
         }
     },
-    "revision": "20170428",
+    "revision": "20170818",
     "rootUrl": "https://www.googleapis.com/",
     "schemas": {
         "Account": {
             "description": "Contains properties of a DCM account.",
             "id": "Account",
             "properties": {
                 "accountPermissionIds": {
                     "description": "Account permissions assigned to this account.",
                     "items": {
                         "format": "int64",
@@ skipping 1617 matching lines @@
                     "type": "boolean"
                 },
                 "customVariables": {
                     "description": "Custom floodlight variables.",
                     "items": {
                         "$ref": "CustomFloodlightVariable"
                     },
                     "type": "array"
                 },
                 "encryptedUserId": {
-                    "description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.",
+                    "description": "The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field.",
                     "type": "string"
                 },
                 "encryptedUserIdCandidates": {
-                    "description": "A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.",
+                    "description": "A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field.",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "floodlightActivityId": {
                     "description": "Floodlight Activity ID of this conversion. This is a required field.",
                     "format": "int64",
                     "type": "string"
                 },
                 "floodlightConfigurationId": {
                     "description": "Floodlight Configuration ID of this conversion. This is a required field.",
                     "format": "int64",
                     "type": "string"
                 },
+                "gclid": {
+                    "description": "The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field.",
+                    "type": "string"
+                },
                 "kind": {
                     "default": "dfareporting#conversion",
                     "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#conversion\".",
                     "type": "string"
                 },
                 "limitAdTracking": {
                     "description": "Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.",
                     "type": "boolean"
                 },
                 "mobileDeviceId": {
-                    "description": "The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.",
+                    "description": "The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field.",
                     "type": "string"
                 },
                 "ordinal": {
                     "description": "The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.",
                     "type": "string"
                 },
                 "quantity": {
                     "description": "The quantity of the conversion.",
                     "format": "int64",
                     "type": "string"
@@ skipping 533 matching lines @@
                     "items": {
                         "$ref": "CreativeCustomEvent"
                     },
                     "type": "array"
                 },
                 "fsCommand": {
                     "$ref": "FsCommand",
                     "description": "OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE."
                 },
                 "htmlCode": {
-                    "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.",
+                    "description": "HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.",
                     "type": "string"
                 },
                 "htmlCodeLocked": {
                     "description": "Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.",
                     "type": "boolean"
                 },
                 "id": {
                     "description": "ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.",
                     "format": "int64",
                     "type": "string"
@@ skipping 2323 matching lines @@
                 },
                 "nielsenOcrOptOut": {
                     "description": "Whether this directory site has disabled Nielsen OCR reach ratings.",
                     "type": "boolean"
                 },
                 "verificationTagOptOut": {
                     "description": "Whether this directory site has disabled generation of Verification ins tags.",
                     "type": "boolean"
                 },
                 "videoActiveViewOptOut": {
-                    "description": "Whether this directory site has disabled active view for in-stream video creatives.",
+                    "description": "Whether this directory site has disabled active view for in-stream video creatives. This is a read-only field.",
                     "type": "boolean"
                 }
             },
             "type": "object"
         },
         "DirectorySitesListResponse": {
             "description": "Directory Site List Response",
             "id": "DirectorySitesListResponse",
             "properties": {
                 "directorySites": {
@@ skipping 610 matching lines @@
                         "",
                         ""
                     ],
                     "type": "string"
                 },
                 "tagString": {
                     "description": "Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.",
                     "type": "string"
                 },
                 "userDefinedVariableTypes": {
-                    "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-20]=\" in the tags. Each of these can have a user defined type.\nAcceptable values are:\n- \"U1\"\n- \"U2\"\n- \"U3\"\n- \"U4\"\n- \"U5\"\n- \"U6\"\n- \"U7\"\n- \"U8\"\n- \"U9\"\n- \"U10\"\n- \"U11\"\n- \"U12\"\n- \"U13\"\n- \"U14\"\n- \"U15\"\n- \"U16\"\n- \"U17\"\n- \"U18\"\n- \"U19\"\n- \"U20\"",
+                    "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-100]=\" in the tags. Each of these can have a user defined type.\nAcceptable values are U1 to U100, inclusive.",
                     "items": {
                         "enum": [
                             "U1",
                             "U10",
                             "U100",
                             "U11",
                             "U12",
                             "U13",
                             "U14",
                             "U15",
@@ skipping 1889 matching lines @@
                 },
                 "videoActiveViewOptOut": {
                     "description": "Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.",
                     "type": "boolean"
                 },
                 "videoSettings": {
                     "$ref": "VideoSettings",
                     "description": "A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility."
                 },
                 "vpaidAdapterChoice": {
-                    "description": "VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement.",
+                    "description": "VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement.\n\nNote: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
                     "enum": [
                         "BOTH",
                         "DEFAULT",
                         "FLASH",
                         "HTML5"
                     ],
                     "enumDescriptions": [
                         "",
                         "",
                         "",
@@ skipping 1871 matching lines @@
                 },
                 "tagSetting": {
                     "$ref": "TagSetting",
                     "description": "Configuration settings for dynamic and image floodlight tags."
                 },
                 "videoActiveViewOptOutTemplate": {
                     "description": "Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.",
                     "type": "boolean"
                 },
                 "vpaidAdapterChoiceTemplate": {
-                    "description": "Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter, and Flash VPAID creatives use the Flash adapter).",
+                    "description": "Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter).\n\nNote: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.",
                     "enum": [
                         "BOTH",
                         "DEFAULT",
                         "FLASH",
                         "HTML5"
                     ],
                     "enumDescriptions": [
                         "",
                         "",
                         "",
@@ skipping 1268 matching lines @@
                     "description": "Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden."
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "dfareporting/v2.8/",
     "title": "DCM/DFA Reporting And Trafficking API",
     "version": "v2.8"
 }