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