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