Home | History | Annotate | Download | only in dyn 
      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_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.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 
     85 Args:
     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 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.
     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         "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.
    133         "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
    134       },
    135     ],
    136     "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
    137       "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
    138       "value": "A String", # The value of the dimension.
    139       "dimensionName": "A String", # The name of the dimension.
    140       "etag": "A String", # The eTag of this response for caching purposes.
    141       "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.
    142       "id": "A String", # The ID associated with the value if available.
    143     },
    144     "id": "A String", # Numeric ID of the asset. This is a read-only, auto-generated field.
    145   }
    146 
    147   media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
    148   media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
    149 
    150 Returns:
    151   An object of the form:
    152 
    153     { # 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.
    154       "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
    155       "detectedFeatures": [ # 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.
    156         "A String",
    157       ],
    158       "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
    159           #
    160           # Possible values are:
    161           # - "ADMOB_REFERENCED"
    162           # - "ASSET_FORMAT_UNSUPPORTED_DCM"
    163           # - "ASSET_INVALID"
    164           # - "CLICK_TAG_HARD_CODED"
    165           # - "CLICK_TAG_INVALID"
    166           # - "CLICK_TAG_IN_GWD"
    167           # - "CLICK_TAG_MISSING"
    168           # - "CLICK_TAG_MORE_THAN_ONE"
    169           # - "CLICK_TAG_NON_TOP_LEVEL"
    170           # - "COMPONENT_UNSUPPORTED_DCM"
    171           # - "ENABLER_UNSUPPORTED_METHOD_DCM"
    172           # - "EXTERNAL_FILE_REFERENCED"
    173           # - "FILE_DETAIL_EMPTY"
    174           # - "FILE_TYPE_INVALID"
    175           # - "GWD_PROPERTIES_INVALID"
    176           # - "HTML5_FEATURE_UNSUPPORTED"
    177           # - "LINKED_FILE_NOT_FOUND"
    178           # - "MAX_FLASH_VERSION_11"
    179           # - "MRAID_REFERENCED"
    180           # - "NOT_SSL_COMPLIANT"
    181           # - "ORPHANED_ASSET"
    182           # - "PRIMARY_HTML_MISSING"
    183           # - "SVG_INVALID"
    184           # - "ZIP_INVALID"
    185         "A String",
    186       ],
    187       "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
    188         "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.
    189         "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.
    190       },
    191       "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
    192         { # Creative Click Tag.
    193           "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.
    194           "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.
    195           "value": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
    196         },
    197       ],
    198       "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
    199         "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
    200         "value": "A String", # The value of the dimension.
    201         "dimensionName": "A String", # The name of the dimension.
    202         "etag": "A String", # The eTag of this response for caching purposes.
    203         "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.
    204         "id": "A String", # The ID associated with the value if available.
    205       },
    206       "id": "A String", # Numeric ID of the asset. This is a read-only, auto-generated field.
    207     }</pre>
    208 </div>
    209 
    210 </body></html>