• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dfareporting_v3_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_2.creativeAssets.html">creativeAssets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#insert">insert(profileId, advertiserId, body=None, media_body=None, media_mime_type=None)</a></code></p>
79<p class="firstline">Inserts a new creative asset.</p>
80<h3>Method Details</h3>
81<div class="method">
82    <code class="details" id="insert">insert(profileId, advertiserId, body=None, media_body=None, media_mime_type=None)</code>
83  <pre>Inserts a new creative asset.
84
85Args:
86  profileId: string, User profile ID associated with this request. (required)
87  advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
88  body: object, The request body.
89    The object takes the form of:
90
91{ # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
92    "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
93    "detectedFeatures": [ # 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.
94      "A String",
95    ],
96    "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
97        #
98        # Possible values are:
99        # - "ADMOB_REFERENCED"
100        # - "ASSET_FORMAT_UNSUPPORTED_DCM"
101        # - "ASSET_INVALID"
102        # - "CLICK_TAG_HARD_CODED"
103        # - "CLICK_TAG_INVALID"
104        # - "CLICK_TAG_IN_GWD"
105        # - "CLICK_TAG_MISSING"
106        # - "CLICK_TAG_MORE_THAN_ONE"
107        # - "CLICK_TAG_NON_TOP_LEVEL"
108        # - "COMPONENT_UNSUPPORTED_DCM"
109        # - "ENABLER_UNSUPPORTED_METHOD_DCM"
110        # - "EXTERNAL_FILE_REFERENCED"
111        # - "FILE_DETAIL_EMPTY"
112        # - "FILE_TYPE_INVALID"
113        # - "GWD_PROPERTIES_INVALID"
114        # - "HTML5_FEATURE_UNSUPPORTED"
115        # - "LINKED_FILE_NOT_FOUND"
116        # - "MAX_FLASH_VERSION_11"
117        # - "MRAID_REFERENCED"
118        # - "NOT_SSL_COMPLIANT"
119        # - "ORPHANED_ASSET"
120        # - "PRIMARY_HTML_MISSING"
121        # - "SVG_INVALID"
122        # - "ZIP_INVALID"
123      "A String",
124    ],
125    "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
126      "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
127      "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
128    },
129    "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
130      { # Creative Click Tag.
131        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
132        "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
133          "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
134              # - If landingPageId is specified then that landing page's URL is assigned to this field.
135              # - Otherwise, the customClickThroughUrl is assigned to this field.
136          "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
137          "landingPageId": "A String", # ID of the landing page for the click-through URL.
138        },
139        "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
140      },
141    ],
142    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
143      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
144      "value": "A String", # The value of the dimension.
145      "dimensionName": "A String", # The name of the dimension.
146      "etag": "A String", # The eTag of this response for caching purposes.
147      "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
148      "id": "A String", # The ID associated with the value if available.
149    },
150    "id": "A String", # Numeric ID of the asset. This is a read-only, auto-generated field.
151  }
152
153  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
154  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
155
156Returns:
157  An object of the form:
158
159    { # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
160      "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
161      "detectedFeatures": [ # 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.
162        "A String",
163      ],
164      "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
165          #
166          # Possible values are:
167          # - "ADMOB_REFERENCED"
168          # - "ASSET_FORMAT_UNSUPPORTED_DCM"
169          # - "ASSET_INVALID"
170          # - "CLICK_TAG_HARD_CODED"
171          # - "CLICK_TAG_INVALID"
172          # - "CLICK_TAG_IN_GWD"
173          # - "CLICK_TAG_MISSING"
174          # - "CLICK_TAG_MORE_THAN_ONE"
175          # - "CLICK_TAG_NON_TOP_LEVEL"
176          # - "COMPONENT_UNSUPPORTED_DCM"
177          # - "ENABLER_UNSUPPORTED_METHOD_DCM"
178          # - "EXTERNAL_FILE_REFERENCED"
179          # - "FILE_DETAIL_EMPTY"
180          # - "FILE_TYPE_INVALID"
181          # - "GWD_PROPERTIES_INVALID"
182          # - "HTML5_FEATURE_UNSUPPORTED"
183          # - "LINKED_FILE_NOT_FOUND"
184          # - "MAX_FLASH_VERSION_11"
185          # - "MRAID_REFERENCED"
186          # - "NOT_SSL_COMPLIANT"
187          # - "ORPHANED_ASSET"
188          # - "PRIMARY_HTML_MISSING"
189          # - "SVG_INVALID"
190          # - "ZIP_INVALID"
191        "A String",
192      ],
193      "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
194        "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
195        "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
196      },
197      "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
198        { # Creative Click Tag.
199          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
200          "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
201            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
202                # - If landingPageId is specified then that landing page's URL is assigned to this field.
203                # - Otherwise, the customClickThroughUrl is assigned to this field.
204            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
205            "landingPageId": "A String", # ID of the landing page for the click-through URL.
206          },
207          "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
208        },
209      ],
210      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
211        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
212        "value": "A String", # The value of the dimension.
213        "dimensionName": "A String", # The name of the dimension.
214        "etag": "A String", # The eTag of this response for caching purposes.
215        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
216        "id": "A String", # The ID associated with the value if available.
217      },
218      "id": "A String", # Numeric ID of the asset. This is a read-only, auto-generated field.
219    }</pre>
220</div>
221
222</body></html>