Debian Codegraph @

docs/dyn/dfareporting_v3_3.creativeAssets.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.creativeAssets.html">creativeAssets</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#insert">insert(profileId, advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Inserts a new creative asset.</p>
83 <h3>Method Details</h3>
84 <div class="method">
85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87 </div>
88
89 <div class="method">
90 <code class="details" id="insert">insert(profileId, advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</code>
91 <pre>Inserts a new creative asset.
92
93 Args:
94 profileId: string, User profile ID associated with this request. (required)
95 advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
96 body: object, The request body.
97 The object takes the form of:
98
99 { # 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.
100 &quot;assetIdentifier&quot;: { # Creative Asset ID. # ID of the creative asset. This is a required field.
101 &quot;name&quot;: &quot;A String&quot;, # 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: &quot;.-_ &quot;. Spaces are allowed.
102 &quot;type&quot;: &quot;A String&quot;, # 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.
103 },
104 &quot;clickTags&quot;: [ # List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.
105 { # Creative Click Tag.
106 &quot;clickThroughUrl&quot;: { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
107 &quot;computedClickThroughUrl&quot;: &quot;A String&quot;, # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page&#x27;s URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
108 &quot;customClickThroughUrl&quot;: &quot;A String&quot;, # Custom click-through URL. Applicable if the landingPageId field is left unset.
109 &quot;landingPageId&quot;: &quot;A String&quot;, # ID of the landing page for the click-through URL.
110 },
111 &quot;eventName&quot;: &quot;A String&quot;, # 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.
112 &quot;name&quot;: &quot;A String&quot;, # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset&#x27;s creativeAssetId.name field.
113 },
114 ],
115 &quot;detectedFeatures&quot;: [ # 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.
116 &quot;A String&quot;,
117 ],
118 &quot;id&quot;: &quot;A String&quot;, # Numeric ID of the asset. This is a read-only, auto-generated field.
119 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
120 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
121 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
122 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
123 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
124 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
125 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
126 },
127 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeAssetMetadata&quot;.
128 &quot;warnedValidationRules&quot;: [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - &quot;ADMOB_REFERENCED&quot; - &quot;ASSET_FORMAT_UNSUPPORTED_DCM&quot; - &quot;ASSET_INVALID&quot; - &quot;CLICK_TAG_HARD_CODED&quot; - &quot;CLICK_TAG_INVALID&quot; - &quot;CLICK_TAG_IN_GWD&quot; - &quot;CLICK_TAG_MISSING&quot; - &quot;CLICK_TAG_MORE_THAN_ONE&quot; - &quot;CLICK_TAG_NON_TOP_LEVEL&quot; - &quot;COMPONENT_UNSUPPORTED_DCM&quot; - &quot;ENABLER_UNSUPPORTED_METHOD_DCM&quot; - &quot;EXTERNAL_FILE_REFERENCED&quot; - &quot;FILE_DETAIL_EMPTY&quot; - &quot;FILE_TYPE_INVALID&quot; - &quot;GWD_PROPERTIES_INVALID&quot; - &quot;HTML5_FEATURE_UNSUPPORTED&quot; - &quot;LINKED_FILE_NOT_FOUND&quot; - &quot;MAX_FLASH_VERSION_11&quot; - &quot;MRAID_REFERENCED&quot; - &quot;NOT_SSL_COMPLIANT&quot; - &quot;ORPHANED_ASSET&quot; - &quot;PRIMARY_HTML_MISSING&quot; - &quot;SVG_INVALID&quot; - &quot;ZIP_INVALID&quot;
129 &quot;A String&quot;,
130 ],
131 }
132
133 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
134 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140 Returns:
141 An object of the form:
142
143 { # 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.
144 &quot;assetIdentifier&quot;: { # Creative Asset ID. # ID of the creative asset. This is a required field.
145 &quot;name&quot;: &quot;A String&quot;, # 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: &quot;.-_ &quot;. Spaces are allowed.
146 &quot;type&quot;: &quot;A String&quot;, # 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.
147 },
148 &quot;clickTags&quot;: [ # List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.
149 { # Creative Click Tag.
150 &quot;clickThroughUrl&quot;: { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
151 &quot;computedClickThroughUrl&quot;: &quot;A String&quot;, # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page&#x27;s URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
152 &quot;customClickThroughUrl&quot;: &quot;A String&quot;, # Custom click-through URL. Applicable if the landingPageId field is left unset.
153 &quot;landingPageId&quot;: &quot;A String&quot;, # ID of the landing page for the click-through URL.
154 },
155 &quot;eventName&quot;: &quot;A String&quot;, # 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.
156 &quot;name&quot;: &quot;A String&quot;, # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset&#x27;s creativeAssetId.name field.
157 },
158 ],
159 &quot;detectedFeatures&quot;: [ # 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.
160 &quot;A String&quot;,
161 ],
162 &quot;id&quot;: &quot;A String&quot;, # Numeric ID of the asset. This is a read-only, auto-generated field.
163 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
164 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
165 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
166 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
167 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
168 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
169 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
170 },
171 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#creativeAssetMetadata&quot;.
172 &quot;warnedValidationRules&quot;: [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - &quot;ADMOB_REFERENCED&quot; - &quot;ASSET_FORMAT_UNSUPPORTED_DCM&quot; - &quot;ASSET_INVALID&quot; - &quot;CLICK_TAG_HARD_CODED&quot; - &quot;CLICK_TAG_INVALID&quot; - &quot;CLICK_TAG_IN_GWD&quot; - &quot;CLICK_TAG_MISSING&quot; - &quot;CLICK_TAG_MORE_THAN_ONE&quot; - &quot;CLICK_TAG_NON_TOP_LEVEL&quot; - &quot;COMPONENT_UNSUPPORTED_DCM&quot; - &quot;ENABLER_UNSUPPORTED_METHOD_DCM&quot; - &quot;EXTERNAL_FILE_REFERENCED&quot; - &quot;FILE_DETAIL_EMPTY&quot; - &quot;FILE_TYPE_INVALID&quot; - &quot;GWD_PROPERTIES_INVALID&quot; - &quot;HTML5_FEATURE_UNSUPPORTED&quot; - &quot;LINKED_FILE_NOT_FOUND&quot; - &quot;MAX_FLASH_VERSION_11&quot; - &quot;MRAID_REFERENCED&quot; - &quot;NOT_SSL_COMPLIANT&quot; - &quot;ORPHANED_ASSET&quot; - &quot;PRIMARY_HTML_MISSING&quot; - &quot;SVG_INVALID&quot; - &quot;ZIP_INVALID&quot;
173 &quot;A String&quot;,
174 ],
175 }</pre>
176 </div>
177
178 </body></html>