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_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.advertisers.html">advertisers</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#get">get(profileId, id)</a></code></p> 79<p class="firstline">Gets one advertiser by ID.</p> 80<p class="toc_element"> 81 <code><a href="#insert">insert(profileId, body)</a></code></p> 82<p class="firstline">Inserts a new advertiser.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)</a></code></p> 85<p class="firstline">Retrieves a list of advertisers, possibly filtered. This method supports paging.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#patch">patch(profileId, id, body)</a></code></p> 91<p class="firstline">Updates an existing advertiser. This method supports patch semantics.</p> 92<p class="toc_element"> 93 <code><a href="#update">update(profileId, body)</a></code></p> 94<p class="firstline">Updates an existing advertiser.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="get">get(profileId, id)</code> 98 <pre>Gets one advertiser by ID. 99 100Args: 101 profileId: string, User profile ID associated with this request. (required) 102 id: string, Advertiser ID. (required) 103 104Returns: 105 An object of the form: 106 107 { # Contains properties of a DCM advertiser. 108 "status": "A String", # Status of this advertiser. 109 "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". 110 "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank. 111 "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. 112 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. 113 "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. 114 "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. 115 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: 116 # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. 117 # - This advertiser's original floodlight configuration is not already shared with another advertiser. 118 "suspended": True or False, # Suspension status of this advertiser. 119 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 120 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 121 "value": "A String", # The value of the dimension. 122 "dimensionName": "A String", # The name of the dimension. 123 "etag": "A String", # The eTag of this response for caching purposes. 124 "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. 125 "id": "A String", # The ID associated with the value if available. 126 }, 127 "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. 128 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. 129 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 130 "value": "A String", # The value of the dimension. 131 "dimensionName": "A String", # The name of the dimension. 132 "etag": "A String", # The eTag of this response for caching purposes. 133 "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. 134 "id": "A String", # The ID associated with the value if available. 135 }, 136 "defaultEmail": "A String", # Default email address used in sender field for tag emails. 137 "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field. 138 "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank. 139 }</pre> 140</div> 141 142<div class="method"> 143 <code class="details" id="insert">insert(profileId, body)</code> 144 <pre>Inserts a new advertiser. 145 146Args: 147 profileId: string, User profile ID associated with this request. (required) 148 body: object, The request body. (required) 149 The object takes the form of: 150 151{ # Contains properties of a DCM advertiser. 152 "status": "A String", # Status of this advertiser. 153 "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". 154 "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank. 155 "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. 156 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. 157 "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. 158 "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. 159 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: 160 # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. 161 # - This advertiser's original floodlight configuration is not already shared with another advertiser. 162 "suspended": True or False, # Suspension status of this advertiser. 163 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 164 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 165 "value": "A String", # The value of the dimension. 166 "dimensionName": "A String", # The name of the dimension. 167 "etag": "A String", # The eTag of this response for caching purposes. 168 "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. 169 "id": "A String", # The ID associated with the value if available. 170 }, 171 "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. 172 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. 173 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 174 "value": "A String", # The value of the dimension. 175 "dimensionName": "A String", # The name of the dimension. 176 "etag": "A String", # The eTag of this response for caching purposes. 177 "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. 178 "id": "A String", # The ID associated with the value if available. 179 }, 180 "defaultEmail": "A String", # Default email address used in sender field for tag emails. 181 "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field. 182 "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank. 183 } 184 185 186Returns: 187 An object of the form: 188 189 { # Contains properties of a DCM advertiser. 190 "status": "A String", # Status of this advertiser. 191 "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". 192 "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank. 193 "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. 194 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. 195 "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. 196 "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. 197 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: 198 # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. 199 # - This advertiser's original floodlight configuration is not already shared with another advertiser. 200 "suspended": True or False, # Suspension status of this advertiser. 201 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 202 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 203 "value": "A String", # The value of the dimension. 204 "dimensionName": "A String", # The name of the dimension. 205 "etag": "A String", # The eTag of this response for caching purposes. 206 "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. 207 "id": "A String", # The ID associated with the value if available. 208 }, 209 "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. 210 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. 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 "defaultEmail": "A String", # Default email address used in sender field for tag emails. 219 "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field. 220 "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank. 221 }</pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="list">list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)</code> 226 <pre>Retrieves a list of advertisers, possibly filtered. This method supports paging. 227 228Args: 229 profileId: string, User profile ID associated with this request. (required) 230 includeAdvertisersWithoutGroupsOnly: boolean, Select only advertisers which do not belong to any advertiser group. 231 onlyParent: boolean, Select only advertisers which use another advertiser's floodlight configuration. 232 pageToken: string, Value of the nextPageToken from the previous result page. 233 sortOrder: string, Order of sorted results. 234 Allowed values 235 ASCENDING - 236 DESCENDING - 237 status: string, Select only advertisers with the specified status. 238 Allowed values 239 APPROVED - 240 ON_HOLD - 241 maxResults: integer, Maximum number of results to return. 242 advertiserGroupIds: string, Select only advertisers with these advertiser group IDs. (repeated) 243 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". 244 subaccountId: string, Select only advertisers with these subaccount IDs. 245 ids: string, Select only advertisers with these IDs. (repeated) 246 floodlightConfigurationIds: string, Select only advertisers with these floodlight configuration IDs. (repeated) 247 sortField: string, Field by which to sort the list. 248 Allowed values 249 ID - 250 NAME - 251 252Returns: 253 An object of the form: 254 255 { # Advertiser List Response 256 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 257 "advertisers": [ # Advertiser collection. 258 { # Contains properties of a DCM advertiser. 259 "status": "A String", # Status of this advertiser. 260 "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". 261 "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank. 262 "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. 263 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. 264 "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. 265 "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. 266 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: 267 # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. 268 # - This advertiser's original floodlight configuration is not already shared with another advertiser. 269 "suspended": True or False, # Suspension status of this advertiser. 270 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 271 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 272 "value": "A String", # The value of the dimension. 273 "dimensionName": "A String", # The name of the dimension. 274 "etag": "A String", # The eTag of this response for caching purposes. 275 "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. 276 "id": "A String", # The ID associated with the value if available. 277 }, 278 "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. 279 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. 280 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 281 "value": "A String", # The value of the dimension. 282 "dimensionName": "A String", # The name of the dimension. 283 "etag": "A String", # The eTag of this response for caching purposes. 284 "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. 285 "id": "A String", # The ID associated with the value if available. 286 }, 287 "defaultEmail": "A String", # Default email address used in sender field for tag emails. 288 "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field. 289 "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank. 290 }, 291 ], 292 "kind": "dfareporting#advertisersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". 293 }</pre> 294</div> 295 296<div class="method"> 297 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 298 <pre>Retrieves the next page of results. 299 300Args: 301 previous_request: The request for the previous page. (required) 302 previous_response: The response from the request for the previous page. (required) 303 304Returns: 305 A request object that you can call 'execute()' on to request the next 306 page. Returns None if there are no more items in the collection. 307 </pre> 308</div> 309 310<div class="method"> 311 <code class="details" id="patch">patch(profileId, id, body)</code> 312 <pre>Updates an existing advertiser. This method supports patch semantics. 313 314Args: 315 profileId: string, User profile ID associated with this request. (required) 316 id: string, Advertiser ID. (required) 317 body: object, The request body. (required) 318 The object takes the form of: 319 320{ # Contains properties of a DCM advertiser. 321 "status": "A String", # Status of this advertiser. 322 "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". 323 "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank. 324 "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. 325 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. 326 "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. 327 "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. 328 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: 329 # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. 330 # - This advertiser's original floodlight configuration is not already shared with another advertiser. 331 "suspended": True or False, # Suspension status of this advertiser. 332 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 333 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 334 "value": "A String", # The value of the dimension. 335 "dimensionName": "A String", # The name of the dimension. 336 "etag": "A String", # The eTag of this response for caching purposes. 337 "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. 338 "id": "A String", # The ID associated with the value if available. 339 }, 340 "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. 341 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. 342 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 343 "value": "A String", # The value of the dimension. 344 "dimensionName": "A String", # The name of the dimension. 345 "etag": "A String", # The eTag of this response for caching purposes. 346 "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. 347 "id": "A String", # The ID associated with the value if available. 348 }, 349 "defaultEmail": "A String", # Default email address used in sender field for tag emails. 350 "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field. 351 "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank. 352 } 353 354 355Returns: 356 An object of the form: 357 358 { # Contains properties of a DCM advertiser. 359 "status": "A String", # Status of this advertiser. 360 "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". 361 "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank. 362 "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. 363 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. 364 "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. 365 "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. 366 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: 367 # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. 368 # - This advertiser's original floodlight configuration is not already shared with another advertiser. 369 "suspended": True or False, # Suspension status of this advertiser. 370 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 371 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 372 "value": "A String", # The value of the dimension. 373 "dimensionName": "A String", # The name of the dimension. 374 "etag": "A String", # The eTag of this response for caching purposes. 375 "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. 376 "id": "A String", # The ID associated with the value if available. 377 }, 378 "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. 379 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. 380 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 381 "value": "A String", # The value of the dimension. 382 "dimensionName": "A String", # The name of the dimension. 383 "etag": "A String", # The eTag of this response for caching purposes. 384 "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. 385 "id": "A String", # The ID associated with the value if available. 386 }, 387 "defaultEmail": "A String", # Default email address used in sender field for tag emails. 388 "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field. 389 "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank. 390 }</pre> 391</div> 392 393<div class="method"> 394 <code class="details" id="update">update(profileId, body)</code> 395 <pre>Updates an existing advertiser. 396 397Args: 398 profileId: string, User profile ID associated with this request. (required) 399 body: object, The request body. (required) 400 The object takes the form of: 401 402{ # Contains properties of a DCM advertiser. 403 "status": "A String", # Status of this advertiser. 404 "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". 405 "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank. 406 "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. 407 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. 408 "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. 409 "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. 410 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: 411 # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. 412 # - This advertiser's original floodlight configuration is not already shared with another advertiser. 413 "suspended": True or False, # Suspension status of this advertiser. 414 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 415 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 416 "value": "A String", # The value of the dimension. 417 "dimensionName": "A String", # The name of the dimension. 418 "etag": "A String", # The eTag of this response for caching purposes. 419 "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. 420 "id": "A String", # The ID associated with the value if available. 421 }, 422 "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. 423 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. 424 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 425 "value": "A String", # The value of the dimension. 426 "dimensionName": "A String", # The name of the dimension. 427 "etag": "A String", # The eTag of this response for caching purposes. 428 "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. 429 "id": "A String", # The ID associated with the value if available. 430 }, 431 "defaultEmail": "A String", # Default email address used in sender field for tag emails. 432 "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field. 433 "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank. 434 } 435 436 437Returns: 438 An object of the form: 439 440 { # Contains properties of a DCM advertiser. 441 "status": "A String", # Status of this advertiser. 442 "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". 443 "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank. 444 "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. 445 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. 446 "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. 447 "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. 448 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: 449 # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. 450 # - This advertiser's original floodlight configuration is not already shared with another advertiser. 451 "suspended": True or False, # Suspension status of this advertiser. 452 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 453 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 454 "value": "A String", # The value of the dimension. 455 "dimensionName": "A String", # The name of the dimension. 456 "etag": "A String", # The eTag of this response for caching purposes. 457 "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. 458 "id": "A String", # The ID associated with the value if available. 459 }, 460 "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. 461 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. 462 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 463 "value": "A String", # The value of the dimension. 464 "dimensionName": "A String", # The name of the dimension. 465 "etag": "A String", # The eTag of this response for caching purposes. 466 "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. 467 "id": "A String", # The ID associated with the value if available. 468 }, 469 "defaultEmail": "A String", # Default email address used in sender field for tag emails. 470 "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field. 471 "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank. 472 }</pre> 473</div> 474 475</body></html>