OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update to latest versions of API declarations

Browse Source
This commit is contained in:
Sebastian Thiel
2018-10-13 13:49:14 +02:00
parent 5a67475b54
commit 255c7f5ad5
1508 changed files with 819225 additions and 838421 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
etc/api/dfareporting/v2.8/dfareporting-api.json
View File

@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/4goAvA_o9T_Nbyckne-XIOvJ_sE\"",
"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/b8e9X2OV7HztttOOjjAf6lAujg0\"",
"discoveryVersion": "v1",
"id": "dfareporting:v2.8",
"name": "dfareporting",
"version": "v2.8",
"revision": "20171109",
"revision": "20180830",
"title": "DCM/DFA Reporting And Trafficking API",
"description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"ownerDomain": "google.com",
@@ -57,12 +57,12 @@
},
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
"description": "Deprecated. Please use quotaUser instead.",
"location": "query"
}
},
@@ -85,7 +85,7 @@
"Account": {
"id": "Account",
"type": "object",
"description": "Contains properties of a DCM account.",
"description": "Contains properties of a Campaign Manager account.",
"properties": {
"accountPermissionIds": {
"type": "array",
@@ -262,7 +262,7 @@
"AccountPermission": {
"id": "AccountPermission",
"type": "object",
"description": "AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.",
"description": "AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.",
"properties": {
"accountProfiles": {
"type": "array",
@@ -374,7 +374,7 @@
"AccountUserProfile": {
"id": "AccountUserProfile",
"type": "object",
"description": "AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
"description": "AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.",
"properties": {
"accountId": {
"type": "string",
@@ -430,7 +430,7 @@
},
"traffickerType": {
"type": "string",
"description": "Trafficker type of this user profile.",
"description": "Trafficker type of this user profile. This is a read-only field.",
"enum": [
"EXTERNAL_TRAFFICKER",
"INTERNAL_NON_TRAFFICKER",
@@ -544,7 +544,7 @@
"Ad": {
"id": "Ad",
"type": "object",
"description": "Contains properties of a DCM ad.",
"description": "Contains properties of a Campaign Manager ad.",
"properties": {
"accountId": {
"type": "string",
@@ -602,6 +602,7 @@
"APP_INTERSTITIAL",
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO"
],
"enumDescriptions": [
@@ -609,6 +610,7 @@
"",
"",
"",
"",
""
]
},
@@ -790,6 +792,7 @@
"APP_INTERSTITIAL",
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO"
],
"enumDescriptions": [
@@ -797,6 +800,7 @@
"",
"",
"",
"",
""
]
},
@@ -863,7 +867,7 @@
"Advertiser": {
"id": "Advertiser",
"type": "object",
"description": "Contains properties of a DCM advertiser.",
"description": "Contains properties of a Campaign Manager advertiser.",
"properties": {
"accountId": {
"type": "string",
@@ -1115,7 +1119,7 @@
"Campaign": {
"id": "Campaign",
"type": "object",
"description": "Contains properties of a DCM campaign.",
"description": "Contains properties of a Campaign Manager campaign.",
"properties": {
"accountId": {
"type": "string",
@@ -1160,7 +1164,7 @@
},
"billingInvoiceCode": {
"type": "string",
"description": "Billing invoice code included in the DCM client billing invoices associated with the campaign."
"description": "Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign."
},
"clickThroughUrlSuffixProperties": {
"$ref": "ClickThroughUrlSuffixProperties",
@@ -2065,7 +2069,7 @@
},
"backupImageFeatures": {
"type": "array",
"description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"description": "List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"items": {
"type": "string",
"enum": [
@@ -2227,7 +2231,7 @@
},
"companionCreatives": {
"type": "array",
"description": "List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
"description": "List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false.",
"items": {
"type": "string",
"format": "int64"
@@ -2243,6 +2247,7 @@
"APP_INTERSTITIAL",
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO"
],
"enumDescriptions": [
@@ -2250,6 +2255,7 @@
"",
"",
"",
"",
""
]
}
@@ -2311,7 +2317,7 @@
},
"htmlCodeLocked": {
"type": "boolean",
"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."
"description": "Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER."
},
"id": {
"type": "string",
@@ -2367,7 +2373,7 @@
},
"requiredFlashVersion": {
"type": "integer",
"description": "The internal Flash version for this creative as calculated by DoubleClick Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"description": "The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"format": "int32"
},
"size": {
@@ -2450,6 +2456,7 @@
"FLASH_INPAGE",
"HTML5_BANNER",
"IMAGE",
"INSTREAM_AUDIO",
"INSTREAM_VIDEO",
"INSTREAM_VIDEO_REDIRECT",
"INTERNAL_REDIRECT",
@@ -2490,6 +2497,7 @@
"",
"",
"",
"",
""
]
},
@@ -2606,7 +2614,7 @@
},
"detectedFeatures": {
"type": "array",
"description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.",
"items": {
"type": "string",
"enum": [
@@ -2839,7 +2847,7 @@
},
"originalBackup": {
"type": "boolean",
"description": "Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA."
"description": "Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA."
},
"position": {
"$ref": "OffsetPosition",
@@ -2888,7 +2896,7 @@
},
"role": {
"type": "string",
"description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.\nPRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.\nADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nTRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM.\nFor VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.",
"description": "Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field.\nPRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.\nBACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.\nADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.\nOTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.\nPARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nTRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives.\nALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager.\nFor VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.",
"enum": [
"ADDITIONAL_FLASH",
"ADDITIONAL_IMAGE",
@@ -3023,7 +3031,7 @@
},
"detectedFeatures": {
"type": "array",
"description": "List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
"description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.",
"items": {
"type": "string",
"enum": [
@@ -3338,7 +3346,7 @@
"properties": {
"advertiserCustomEventId": {
"type": "string",
"description": "Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.",
"description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.",
"format": "int64"
},
"advertiserCustomEventName": {
@@ -3361,7 +3369,7 @@
},
"artworkLabel": {
"type": "string",
"description": "Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion."
"description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion."
},
"artworkType": {
"type": "string",
@@ -4060,9 +4068,11 @@
"type": "string",
"description": "The date range relative to the date of when the report is run.",
"enum": [
"LAST_14_DAYS",
"LAST_24_MONTHS",
"LAST_30_DAYS",
"LAST_365_DAYS",
"LAST_60_DAYS",
"LAST_7_DAYS",
"LAST_90_DAYS",
"MONTH_TO_DATE",
@@ -4091,6 +4101,8 @@
"",
"",
"",
"",
"",
""
]
},
@@ -4176,7 +4188,7 @@
},
"impressionRatio": {
"type": "string",
"description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
"description": "Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.",
"format": "int64"
},
"priority": {
@@ -4224,15 +4236,15 @@
"DfpSettings": {
"id": "DfpSettings",
"type": "object",
"description": "DFP Settings",
"description": "Google Ad Manager Settings",
"properties": {
"dfpNetworkCode": {
"type": "string",
"description": "DFP network code for this directory site."
"description": "Ad Manager network code for this directory site."
},
"dfpNetworkName": {
"type": "string",
"description": "DFP network name for this directory site."
"description": "Ad Manager network name for this directory site."
},
"programmaticPlacementAccepted": {
"type": "boolean",
@@ -4244,7 +4256,7 @@
},
"publisherPortalOnly": {
"type": "boolean",
"description": "Whether this directory site is available only via DoubleClick Publisher Portal."
"description": "Whether this directory site is available only via Publisher Portal."
}
}
},
@@ -4631,7 +4643,7 @@
},
"dfpSettings": {
"$ref": "DfpSettings",
"description": "Directory site DFP settings."
"description": "Directory site Ad Manager settings."
},
"instreamVideoPlacementAccepted": {
"type": "boolean",
@@ -4681,7 +4693,7 @@
"DynamicTargetingKey": {
"id": "DynamicTargetingKey",
"type": "object",
"description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
"description": "Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.",
"properties": {
"kind": {
"type": "string",
@@ -4753,6 +4765,7 @@
"DBM_PARTNER",
"DCM_ACCOUNT",
"DCM_ADVERTISER",
"DFP_NETWORK_CODE",
"ENCRYPTION_ENTITY_TYPE_UNKNOWN"
],
"enumDescriptions": [
@@ -4761,6 +4774,7 @@
"",
"",
"",
"",
""
]
},
@@ -4819,7 +4833,7 @@
},
"excludeFromAdxRequests": {
"type": "boolean",
"description": "Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network."
"description": "Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network."
},
"id": {
"type": "string",
@@ -5715,7 +5729,7 @@
},
"omnitureSettings": {
"$ref": "OmnitureSettings",
"description": "Settings for DCM Omniture integration."
"description": "Settings for Campaign Manager Omniture integration."
},
"subaccountId": {
"type": "string",
@@ -5899,7 +5913,7 @@
"InventoryItem": {
"id": "InventoryItem",
"type": "object",
"description": "Represents a buy from the DoubleClick Planning inventory store.",
"description": "Represents a buy from the Planning inventory store.",
"properties": {
"accountId": {
"type": "string",
@@ -6606,7 +6620,7 @@
"Order": {
"id": "Order",
"type": "object",
"description": "Describes properties of a DoubleClick Planning order.",
"description": "Describes properties of a Planning order.",
"properties": {
"accountId": {
"type": "string",
@@ -6752,7 +6766,7 @@
"OrderDocument": {
"id": "OrderDocument",
"type": "object",
"description": "Contains properties of a DoubleClick Planning order document.",
"description": "Contains properties of a Planning order document.",
"properties": {
"accountId": {
"type": "string",
@@ -6983,6 +6997,7 @@
"APP_INTERSTITIAL",
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO"
],
"enumDescriptions": [
@@ -6990,6 +7005,7 @@
"",
"",
"",
"",
""
]
},
@@ -7822,7 +7838,7 @@
"Project": {
"id": "Project",
"type": "object",
"description": "Contains properties of a DoubleClick Planning project.",
"description": "Contains properties of a Planning project.",
"properties": {
"accountId": {
"type": "string",
@@ -9228,7 +9244,7 @@
"Subaccount": {
"id": "Subaccount",
"type": "object",
"description": "Contains properties of a DCM subaccount.",
"description": "Contains properties of a Campaign Manager subaccount.",
"properties": {
"accountId": {
"type": "string",
@@ -11030,6 +11046,7 @@
"APP_INTERSTITIAL",
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO"
],
"enumDescriptions": [
@@ -11037,6 +11054,7 @@
"",
"",
"",
"",
""
],
"location": "query"
@@ -13817,6 +13835,7 @@
"FLASH_INPAGE",
"HTML5_BANNER",
"IMAGE",
"INSTREAM_AUDIO",
"INSTREAM_VIDEO",
"INSTREAM_VIDEO_REDIRECT",
"INTERNAL_REDIRECT",
@@ -13857,6 +13876,7 @@
"",
"",
"",
"",
""
],
"repeated": true,
@@ -14198,7 +14218,7 @@
},
"dfpNetworkCode": {
"type": "string",
"description": "Select only directory sites with this DFP network code.",
"description": "Select only directory sites with this Ad Manager network code.",
"location": "query"
},
"ids": {
@@ -17094,6 +17114,7 @@
"APP_INTERSTITIAL",
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO"
],
"enumDescriptions": [
@@ -17101,6 +17122,7 @@
"",
"",
"",
"",
""
],
"repeated": true,
@@ -18672,7 +18694,7 @@
"id": "dfareporting.sizes.list",
"path": "userprofiles/{profileId}/sizes",
"httpMethod": "GET",
"description": "Retrieves a list of sizes, possibly filtered.",
"description": "Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.",
"parameters": {
"height": {
"type": "integer",