| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="displayvideo_v1.advertisers.assets.html">assets()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the assets Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="displayvideo_v1.advertisers.campaigns.html">campaigns()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the campaigns Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="displayvideo_v1.advertisers.channels.html">channels()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the channels Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="displayvideo_v1.advertisers.creatives.html">creatives()</a></code> |
| 94 | </p> |
| 95 | <p class="firstline">Returns the creatives Resource.</p> |
| 96 | |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="displayvideo_v1.advertisers.insertionOrders.html">insertionOrders()</a></code> |
| 99 | </p> |
| 100 | <p class="firstline">Returns the insertionOrders Resource.</p> |
| 101 | |
| 102 | <p class="toc_element"> |
| 103 | <code><a href="displayvideo_v1.advertisers.lineItems.html">lineItems()</a></code> |
| 104 | </p> |
| 105 | <p class="firstline">Returns the lineItems Resource.</p> |
| 106 | |
| 107 | <p class="toc_element"> |
| 108 | <code><a href="displayvideo_v1.advertisers.locationLists.html">locationLists()</a></code> |
| 109 | </p> |
| 110 | <p class="firstline">Returns the locationLists Resource.</p> |
| 111 | |
| 112 | <p class="toc_element"> |
| 113 | <code><a href="displayvideo_v1.advertisers.negativeKeywordLists.html">negativeKeywordLists()</a></code> |
| 114 | </p> |
| 115 | <p class="firstline">Returns the negativeKeywordLists Resource.</p> |
| 116 | |
| 117 | <p class="toc_element"> |
| 118 | <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> |
| 119 | <p class="firstline">Creates a new advertiser.</p> |
| 120 | <p class="toc_element"> |
| 121 | <code><a href="#delete">delete(advertiserId, x__xgafv=None)</a></code></p> |
| 122 | <p class="firstline">Deletes an advertiser.</p> |
| 123 | <p class="toc_element"> |
| 124 | <code><a href="#get">get(advertiserId, x__xgafv=None)</a></code></p> |
| 125 | <p class="firstline">Gets an advertiser.</p> |
| 126 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 127 | <code><a href="#list">list(partnerId=None, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 128 | <p class="firstline">Lists advertisers that are accessible to the current user.</p> |
| 129 | <p class="toc_element"> |
| 130 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 131 | <p class="firstline">Retrieves the next page of results.</p> |
| 132 | <p class="toc_element"> |
| 133 | <code><a href="#patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 134 | <p class="firstline">Updates an existing advertiser.</p> |
| 135 | <h3>Method Details</h3> |
| 136 | <div class="method"> |
| 137 | <code class="details" id="create">create(body=None, x__xgafv=None)</code> |
| 138 | <pre>Creates a new advertiser. |
| 139 | Returns the newly created advertiser if successful. |
| 140 | This method can take up to 180 seconds to complete. |
| 141 | |
| 142 | Args: |
| 143 | body: object, The request body. |
| 144 | The object takes the form of: |
| 145 | |
| 146 | { # A single advertiser in Display & Video 360 (DV360). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 147 | "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 148 | "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 149 | "name": "A String", # Output only. The resource name of the advertiser. |
| 150 | "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. |
| 151 | # Only integrationCode is currently |
| 152 | # applicable to advertiser. Other fields of IntegrationDetails are not |
| 153 | # supported and will be ignored if provided. |
| 154 | "details": "A String", # Additional details of the entry in string format. |
| 155 | # |
| 156 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 157 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 158 | # The integration code will show up together with the entry in many |
| 159 | # places in the system, for example, reporting. |
| 160 | # |
| 161 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 162 | }, |
| 163 | "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. |
| 164 | "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 165 | "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers |
| 166 | # only. |
| 167 | "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. |
| 168 | # This value cannot be changed once set to `true`. |
| 169 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 170 | "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and |
| 171 | # third-party ad servers. |
| 172 | # ad servers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 173 | "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports. |
| 174 | "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives. |
| 175 | # |
| 176 | # If absent or empty in |
| 177 | # CreateAdvertiser method, the system |
| 178 | # will automatically create a CM site. |
| 179 | # |
| 180 | # Removing sites from this list may cause DV360 creatives synced from CM to |
| 181 | # be deleted. At least one site must be specified. |
| 182 | "A String", |
| 183 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 184 | "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser. |
| 185 | "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, |
| 186 | # authorize the sharing of information from the given Floodlight |
| 187 | # configuration to this Display & Video 360 advertiser. |
| 188 | "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM. |
| 189 | "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 |
| 190 | # advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 191 | }, |
| 192 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 193 | "displayName": "A String", # Required. The display name of the advertiser. |
| 194 | # |
| 195 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 196 | "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 197 | "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. |
| 198 | # |
| 199 | # Accepted codes and the currencies they represent are: |
| 200 | # |
| 201 | # Currency Code : Currency Name |
| 202 | # |
| 203 | # * `ARS` : Argentine Peso |
| 204 | # * `AUD` : Australian Dollar |
| 205 | # * `BRL` : Brazilian Real |
| 206 | # * `CAD` : Canadian Dollar |
| 207 | # * `CHF` : Swiss Franc |
| 208 | # * `CLP` : Chilean Peso |
| 209 | # * `CNY` : Chinese Yuan |
| 210 | # * `COP` : Colombian Peso |
| 211 | # * `CZK` : Czech Koruna |
| 212 | # * `DKK` : Danish Krone |
| 213 | # * `EGP` : Egyption Pound |
| 214 | # * `EUR` : Euro |
| 215 | # * `GBP` : British Pound |
| 216 | # * `HKD` : Hong Kong Dollar |
| 217 | # * `HUF` : Hungarian Forint |
| 218 | # * `IDR` : Indonesian Rupiah |
| 219 | # * `ILS` : Israeli Shekel |
| 220 | # * `INR` : Indian Rupee |
| 221 | # * `JPY` : Japanese Yen |
| 222 | # * `KRW` : South Korean Won |
| 223 | # * `MXN` : Mexican Pesos |
| 224 | # * `MYR` : Malaysian Ringgit |
| 225 | # * `NGN` : Nigerian Naira |
| 226 | # * `NOK` : Norwegian Krone |
| 227 | # * `NZD` : New Zealand Dollar |
| 228 | # * `PEN` : Peruvian Nuevo Sol |
| 229 | # * `PLN` : Polish Zloty |
| 230 | # * `RON` : New Romanian Leu |
| 231 | # * `RUB` : Russian Ruble |
| 232 | # * `SEK` : Swedish Krona |
| 233 | # * `TRY` : Turkish Lira |
| 234 | # * `TWD` : New Taiwan Dollar |
| 235 | # * `USD` : US Dollar |
| 236 | # * `ZAR` : South African Rand |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 237 | "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. |
| 238 | # The system will send this information to publishers that require website |
| 239 | # URL to associate a campaign with an advertiser. |
| 240 | # |
| 241 | # Provide a URL with no path or query string, beginning with `http:` or |
| 242 | # `https:`. |
| 243 | # For example, http://www.example.com |
| 244 | "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. |
| 245 | # For example, `America/New_York`. |
| 246 | # |
| 247 | # See more at: |
| 248 | # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
| 249 | # |
| 250 | # For CM hybrid advertisers, the time zone is the same as that of the |
| 251 | # associated CM account; for third-party only advertisers, the time zone is |
| 252 | # the same as that of the parent partner. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 253 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 254 | "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed. |
| 255 | "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. |
| 256 | # |
| 257 | # If not specified, the SDF settings of the parent partner are used. |
| 258 | "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. |
| 259 | # |
| 260 | # * Required when |
| 261 | # overridePartnerSdfConfig |
| 262 | # is `true`. |
| 263 | # * Output only when |
| 264 | # overridePartnerSdfConfig |
| 265 | # is `false`. |
| 266 | "version": "A String", # Required. The version of SDF being used. |
| 267 | "adminEmail": "A String", # An administrator email address to which the SDF processing status reports |
| 268 | # will be sent. |
| 269 | }, |
| 270 | "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its |
| 271 | # parent partner. |
| 272 | # |
| 273 | # By default, an advertiser inherits the SDF configuration from the parent |
| 274 | # partner. To override the partner configuration, set this field to `true` |
| 275 | # and provide the new configuration in |
| 276 | # sdfConfig. |
| 277 | }, |
| 278 | }, |
| 279 | "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the |
| 280 | # advertiser can spend their budgets and bid on inventory. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 281 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 282 | # * Accepted values are `ENTITY_STATUS_ACTIVE` and |
| 283 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. |
| 284 | # * If set to |
| 285 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 |
| 286 | # days from when it was first scheduled for deletion. |
| 287 | "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. |
| 288 | "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. |
| 289 | "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA) |
| 290 | # compliance. |
| 291 | # |
| 292 | # Warning: Changing OBA settings may cause the audit status of your creatives |
| 293 | # to be reset by some ad exchanges, making them ineligible to serve until |
| 294 | # they are re-approved. |
| 295 | "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, |
| 296 | # authorize Google to use video creatives associated with this Display & |
| 297 | # Video 360 advertiser to provide reporting and features related to the |
| 298 | # advertiser's television campaigns. |
| 299 | # |
| 300 | # Applicable only when the advertiser has a |
| 301 | # CM hybrid ad server |
| 302 | # configuration. |
| 303 | "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service |
| 304 | # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag |
| 305 | # containing this ID to the creative tag. |
| 306 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | } |
| 308 | |
| 309 | x__xgafv: string, V1 error format. |
| 310 | Allowed values |
| 311 | 1 - v1 error format |
| 312 | 2 - v2 error format |
| 313 | |
| 314 | Returns: |
| 315 | An object of the form: |
| 316 | |
| 317 | { # A single advertiser in Display & Video 360 (DV360). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 318 | "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 319 | "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 320 | "name": "A String", # Output only. The resource name of the advertiser. |
| 321 | "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. |
| 322 | # Only integrationCode is currently |
| 323 | # applicable to advertiser. Other fields of IntegrationDetails are not |
| 324 | # supported and will be ignored if provided. |
| 325 | "details": "A String", # Additional details of the entry in string format. |
| 326 | # |
| 327 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 328 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 329 | # The integration code will show up together with the entry in many |
| 330 | # places in the system, for example, reporting. |
| 331 | # |
| 332 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 333 | }, |
| 334 | "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. |
| 335 | "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 336 | "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers |
| 337 | # only. |
| 338 | "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. |
| 339 | # This value cannot be changed once set to `true`. |
| 340 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 341 | "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and |
| 342 | # third-party ad servers. |
| 343 | # ad servers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 344 | "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports. |
| 345 | "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives. |
| 346 | # |
| 347 | # If absent or empty in |
| 348 | # CreateAdvertiser method, the system |
| 349 | # will automatically create a CM site. |
| 350 | # |
| 351 | # Removing sites from this list may cause DV360 creatives synced from CM to |
| 352 | # be deleted. At least one site must be specified. |
| 353 | "A String", |
| 354 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 355 | "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser. |
| 356 | "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, |
| 357 | # authorize the sharing of information from the given Floodlight |
| 358 | # configuration to this Display & Video 360 advertiser. |
| 359 | "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM. |
| 360 | "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 |
| 361 | # advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 362 | }, |
| 363 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 364 | "displayName": "A String", # Required. The display name of the advertiser. |
| 365 | # |
| 366 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 367 | "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 368 | "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. |
| 369 | # |
| 370 | # Accepted codes and the currencies they represent are: |
| 371 | # |
| 372 | # Currency Code : Currency Name |
| 373 | # |
| 374 | # * `ARS` : Argentine Peso |
| 375 | # * `AUD` : Australian Dollar |
| 376 | # * `BRL` : Brazilian Real |
| 377 | # * `CAD` : Canadian Dollar |
| 378 | # * `CHF` : Swiss Franc |
| 379 | # * `CLP` : Chilean Peso |
| 380 | # * `CNY` : Chinese Yuan |
| 381 | # * `COP` : Colombian Peso |
| 382 | # * `CZK` : Czech Koruna |
| 383 | # * `DKK` : Danish Krone |
| 384 | # * `EGP` : Egyption Pound |
| 385 | # * `EUR` : Euro |
| 386 | # * `GBP` : British Pound |
| 387 | # * `HKD` : Hong Kong Dollar |
| 388 | # * `HUF` : Hungarian Forint |
| 389 | # * `IDR` : Indonesian Rupiah |
| 390 | # * `ILS` : Israeli Shekel |
| 391 | # * `INR` : Indian Rupee |
| 392 | # * `JPY` : Japanese Yen |
| 393 | # * `KRW` : South Korean Won |
| 394 | # * `MXN` : Mexican Pesos |
| 395 | # * `MYR` : Malaysian Ringgit |
| 396 | # * `NGN` : Nigerian Naira |
| 397 | # * `NOK` : Norwegian Krone |
| 398 | # * `NZD` : New Zealand Dollar |
| 399 | # * `PEN` : Peruvian Nuevo Sol |
| 400 | # * `PLN` : Polish Zloty |
| 401 | # * `RON` : New Romanian Leu |
| 402 | # * `RUB` : Russian Ruble |
| 403 | # * `SEK` : Swedish Krona |
| 404 | # * `TRY` : Turkish Lira |
| 405 | # * `TWD` : New Taiwan Dollar |
| 406 | # * `USD` : US Dollar |
| 407 | # * `ZAR` : South African Rand |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 408 | "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. |
| 409 | # The system will send this information to publishers that require website |
| 410 | # URL to associate a campaign with an advertiser. |
| 411 | # |
| 412 | # Provide a URL with no path or query string, beginning with `http:` or |
| 413 | # `https:`. |
| 414 | # For example, http://www.example.com |
| 415 | "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. |
| 416 | # For example, `America/New_York`. |
| 417 | # |
| 418 | # See more at: |
| 419 | # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
| 420 | # |
| 421 | # For CM hybrid advertisers, the time zone is the same as that of the |
| 422 | # associated CM account; for third-party only advertisers, the time zone is |
| 423 | # the same as that of the parent partner. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 424 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 425 | "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed. |
| 426 | "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. |
| 427 | # |
| 428 | # If not specified, the SDF settings of the parent partner are used. |
| 429 | "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. |
| 430 | # |
| 431 | # * Required when |
| 432 | # overridePartnerSdfConfig |
| 433 | # is `true`. |
| 434 | # * Output only when |
| 435 | # overridePartnerSdfConfig |
| 436 | # is `false`. |
| 437 | "version": "A String", # Required. The version of SDF being used. |
| 438 | "adminEmail": "A String", # An administrator email address to which the SDF processing status reports |
| 439 | # will be sent. |
| 440 | }, |
| 441 | "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its |
| 442 | # parent partner. |
| 443 | # |
| 444 | # By default, an advertiser inherits the SDF configuration from the parent |
| 445 | # partner. To override the partner configuration, set this field to `true` |
| 446 | # and provide the new configuration in |
| 447 | # sdfConfig. |
| 448 | }, |
| 449 | }, |
| 450 | "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the |
| 451 | # advertiser can spend their budgets and bid on inventory. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 452 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 453 | # * Accepted values are `ENTITY_STATUS_ACTIVE` and |
| 454 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. |
| 455 | # * If set to |
| 456 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 |
| 457 | # days from when it was first scheduled for deletion. |
| 458 | "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. |
| 459 | "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. |
| 460 | "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA) |
| 461 | # compliance. |
| 462 | # |
| 463 | # Warning: Changing OBA settings may cause the audit status of your creatives |
| 464 | # to be reset by some ad exchanges, making them ineligible to serve until |
| 465 | # they are re-approved. |
| 466 | "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, |
| 467 | # authorize Google to use video creatives associated with this Display & |
| 468 | # Video 360 advertiser to provide reporting and features related to the |
| 469 | # advertiser's television campaigns. |
| 470 | # |
| 471 | # Applicable only when the advertiser has a |
| 472 | # CM hybrid ad server |
| 473 | # configuration. |
| 474 | "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service |
| 475 | # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag |
| 476 | # containing this ID to the creative tag. |
| 477 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 478 | }</pre> |
| 479 | </div> |
| 480 | |
| 481 | <div class="method"> |
| 482 | <code class="details" id="delete">delete(advertiserId, x__xgafv=None)</code> |
| 483 | <pre>Deletes an advertiser. |
| 484 | Deleting an advertiser will delete all of its child resources, for example, |
| 485 | campaigns, insertion orders and line items. |
| 486 | A deleted advertiser cannot be recovered. |
| 487 | |
| 488 | Args: |
| 489 | advertiserId: string, The ID of the advertiser we need to delete. (required) |
| 490 | x__xgafv: string, V1 error format. |
| 491 | Allowed values |
| 492 | 1 - v1 error format |
| 493 | 2 - v2 error format |
| 494 | |
| 495 | Returns: |
| 496 | An object of the form: |
| 497 | |
| 498 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 499 | # empty messages in your APIs. A typical example is to use it as the request |
| 500 | # or the response type of an API method. For instance: |
| 501 | # |
| 502 | # service Foo { |
| 503 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 504 | # } |
| 505 | # |
| 506 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 507 | }</pre> |
| 508 | </div> |
| 509 | |
| 510 | <div class="method"> |
| 511 | <code class="details" id="get">get(advertiserId, x__xgafv=None)</code> |
| 512 | <pre>Gets an advertiser. |
| 513 | |
| 514 | Args: |
| 515 | advertiserId: string, Required. The ID of the advertiser to fetch. (required) |
| 516 | x__xgafv: string, V1 error format. |
| 517 | Allowed values |
| 518 | 1 - v1 error format |
| 519 | 2 - v2 error format |
| 520 | |
| 521 | Returns: |
| 522 | An object of the form: |
| 523 | |
| 524 | { # A single advertiser in Display & Video 360 (DV360). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 525 | "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 526 | "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 527 | "name": "A String", # Output only. The resource name of the advertiser. |
| 528 | "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. |
| 529 | # Only integrationCode is currently |
| 530 | # applicable to advertiser. Other fields of IntegrationDetails are not |
| 531 | # supported and will be ignored if provided. |
| 532 | "details": "A String", # Additional details of the entry in string format. |
| 533 | # |
| 534 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 535 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 536 | # The integration code will show up together with the entry in many |
| 537 | # places in the system, for example, reporting. |
| 538 | # |
| 539 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 540 | }, |
| 541 | "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. |
| 542 | "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 543 | "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers |
| 544 | # only. |
| 545 | "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. |
| 546 | # This value cannot be changed once set to `true`. |
| 547 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 548 | "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and |
| 549 | # third-party ad servers. |
| 550 | # ad servers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 551 | "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports. |
| 552 | "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives. |
| 553 | # |
| 554 | # If absent or empty in |
| 555 | # CreateAdvertiser method, the system |
| 556 | # will automatically create a CM site. |
| 557 | # |
| 558 | # Removing sites from this list may cause DV360 creatives synced from CM to |
| 559 | # be deleted. At least one site must be specified. |
| 560 | "A String", |
| 561 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 562 | "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser. |
| 563 | "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, |
| 564 | # authorize the sharing of information from the given Floodlight |
| 565 | # configuration to this Display & Video 360 advertiser. |
| 566 | "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM. |
| 567 | "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 |
| 568 | # advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 569 | }, |
| 570 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 571 | "displayName": "A String", # Required. The display name of the advertiser. |
| 572 | # |
| 573 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 574 | "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 575 | "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. |
| 576 | # |
| 577 | # Accepted codes and the currencies they represent are: |
| 578 | # |
| 579 | # Currency Code : Currency Name |
| 580 | # |
| 581 | # * `ARS` : Argentine Peso |
| 582 | # * `AUD` : Australian Dollar |
| 583 | # * `BRL` : Brazilian Real |
| 584 | # * `CAD` : Canadian Dollar |
| 585 | # * `CHF` : Swiss Franc |
| 586 | # * `CLP` : Chilean Peso |
| 587 | # * `CNY` : Chinese Yuan |
| 588 | # * `COP` : Colombian Peso |
| 589 | # * `CZK` : Czech Koruna |
| 590 | # * `DKK` : Danish Krone |
| 591 | # * `EGP` : Egyption Pound |
| 592 | # * `EUR` : Euro |
| 593 | # * `GBP` : British Pound |
| 594 | # * `HKD` : Hong Kong Dollar |
| 595 | # * `HUF` : Hungarian Forint |
| 596 | # * `IDR` : Indonesian Rupiah |
| 597 | # * `ILS` : Israeli Shekel |
| 598 | # * `INR` : Indian Rupee |
| 599 | # * `JPY` : Japanese Yen |
| 600 | # * `KRW` : South Korean Won |
| 601 | # * `MXN` : Mexican Pesos |
| 602 | # * `MYR` : Malaysian Ringgit |
| 603 | # * `NGN` : Nigerian Naira |
| 604 | # * `NOK` : Norwegian Krone |
| 605 | # * `NZD` : New Zealand Dollar |
| 606 | # * `PEN` : Peruvian Nuevo Sol |
| 607 | # * `PLN` : Polish Zloty |
| 608 | # * `RON` : New Romanian Leu |
| 609 | # * `RUB` : Russian Ruble |
| 610 | # * `SEK` : Swedish Krona |
| 611 | # * `TRY` : Turkish Lira |
| 612 | # * `TWD` : New Taiwan Dollar |
| 613 | # * `USD` : US Dollar |
| 614 | # * `ZAR` : South African Rand |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 615 | "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. |
| 616 | # The system will send this information to publishers that require website |
| 617 | # URL to associate a campaign with an advertiser. |
| 618 | # |
| 619 | # Provide a URL with no path or query string, beginning with `http:` or |
| 620 | # `https:`. |
| 621 | # For example, http://www.example.com |
| 622 | "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. |
| 623 | # For example, `America/New_York`. |
| 624 | # |
| 625 | # See more at: |
| 626 | # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
| 627 | # |
| 628 | # For CM hybrid advertisers, the time zone is the same as that of the |
| 629 | # associated CM account; for third-party only advertisers, the time zone is |
| 630 | # the same as that of the parent partner. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 631 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 632 | "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed. |
| 633 | "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. |
| 634 | # |
| 635 | # If not specified, the SDF settings of the parent partner are used. |
| 636 | "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. |
| 637 | # |
| 638 | # * Required when |
| 639 | # overridePartnerSdfConfig |
| 640 | # is `true`. |
| 641 | # * Output only when |
| 642 | # overridePartnerSdfConfig |
| 643 | # is `false`. |
| 644 | "version": "A String", # Required. The version of SDF being used. |
| 645 | "adminEmail": "A String", # An administrator email address to which the SDF processing status reports |
| 646 | # will be sent. |
| 647 | }, |
| 648 | "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its |
| 649 | # parent partner. |
| 650 | # |
| 651 | # By default, an advertiser inherits the SDF configuration from the parent |
| 652 | # partner. To override the partner configuration, set this field to `true` |
| 653 | # and provide the new configuration in |
| 654 | # sdfConfig. |
| 655 | }, |
| 656 | }, |
| 657 | "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the |
| 658 | # advertiser can spend their budgets and bid on inventory. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 659 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 660 | # * Accepted values are `ENTITY_STATUS_ACTIVE` and |
| 661 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. |
| 662 | # * If set to |
| 663 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 |
| 664 | # days from when it was first scheduled for deletion. |
| 665 | "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. |
| 666 | "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. |
| 667 | "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA) |
| 668 | # compliance. |
| 669 | # |
| 670 | # Warning: Changing OBA settings may cause the audit status of your creatives |
| 671 | # to be reset by some ad exchanges, making them ineligible to serve until |
| 672 | # they are re-approved. |
| 673 | "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, |
| 674 | # authorize Google to use video creatives associated with this Display & |
| 675 | # Video 360 advertiser to provide reporting and features related to the |
| 676 | # advertiser's television campaigns. |
| 677 | # |
| 678 | # Applicable only when the advertiser has a |
| 679 | # CM hybrid ad server |
| 680 | # configuration. |
| 681 | "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service |
| 682 | # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag |
| 683 | # containing this ID to the creative tag. |
| 684 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 685 | }</pre> |
| 686 | </div> |
| 687 | |
| 688 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 689 | <code class="details" id="list">list(partnerId=None, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 690 | <pre>Lists advertisers that are accessible to the current user. |
| 691 | |
| 692 | The order is defined by the order_by |
| 693 | parameter. |
| 694 | |
| 695 | A single partner_id is required. |
| 696 | Cross-partner listing is not supported. |
| 697 | |
| 698 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 699 | partnerId: string, Required. The ID of the partner that the fetched advertisers should all belong to. |
| 700 | The system only supports listing advertisers for one partner at a time. |
| 701 | filter: string, Allows filtering by advertiser properties. |
| 702 | |
| 703 | Supported syntax: |
| 704 | |
| 705 | * Filter expressions are made up of one or more restrictions. |
| 706 | * Restrictions can be combined by `AND` or `OR` logical operators. A |
| 707 | sequence of restrictions implicitly uses `AND`. |
| 708 | * A restriction has the form of `{field} {operator} {value}`. |
| 709 | * The operator must be `EQUALS (=)`. |
| 710 | * Supported fields: |
| 711 | - `entityStatus` |
| 712 | |
| 713 | Examples: |
| 714 | |
| 715 | * All active advertisers under a partner: |
| 716 | `entityStatus="ENTITY_STATUS_ACTIVE"` |
| 717 | |
| 718 | The length of this field should be no more than 500 characters. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 719 | pageToken: string, A token identifying a page of results the server should return. |
| 720 | Typically, this is the value of |
| 721 | next_page_token |
| 722 | returned from the previous call to `ListAdvertisers` method. |
| 723 | If not specified, the first page of results will be returned. |
| 724 | orderBy: string, Field by which to sort the list. |
| 725 | Acceptable values are: |
| 726 | |
| 727 | * `displayName` (default) |
| 728 | * `entityStatus` |
| 729 | |
| 730 | The default sorting order is ascending. To specify descending order for |
| 731 | a field, a suffix "desc" should be added to the field name. For example, |
| 732 | `displayName desc`. |
| 733 | pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will |
| 734 | default to `100`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 735 | x__xgafv: string, V1 error format. |
| 736 | Allowed values |
| 737 | 1 - v1 error format |
| 738 | 2 - v2 error format |
| 739 | |
| 740 | Returns: |
| 741 | An object of the form: |
| 742 | |
| 743 | { |
| 744 | "advertisers": [ # The list of advertisers. |
| 745 | # |
| 746 | # This list will be absent if empty. |
| 747 | { # A single advertiser in Display & Video 360 (DV360). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 748 | "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 749 | "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 750 | "name": "A String", # Output only. The resource name of the advertiser. |
| 751 | "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. |
| 752 | # Only integrationCode is currently |
| 753 | # applicable to advertiser. Other fields of IntegrationDetails are not |
| 754 | # supported and will be ignored if provided. |
| 755 | "details": "A String", # Additional details of the entry in string format. |
| 756 | # |
| 757 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 758 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 759 | # The integration code will show up together with the entry in many |
| 760 | # places in the system, for example, reporting. |
| 761 | # |
| 762 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 763 | }, |
| 764 | "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. |
| 765 | "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 766 | "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers |
| 767 | # only. |
| 768 | "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. |
| 769 | # This value cannot be changed once set to `true`. |
| 770 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 771 | "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and |
| 772 | # third-party ad servers. |
| 773 | # ad servers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 774 | "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports. |
| 775 | "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives. |
| 776 | # |
| 777 | # If absent or empty in |
| 778 | # CreateAdvertiser method, the system |
| 779 | # will automatically create a CM site. |
| 780 | # |
| 781 | # Removing sites from this list may cause DV360 creatives synced from CM to |
| 782 | # be deleted. At least one site must be specified. |
| 783 | "A String", |
| 784 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 785 | "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser. |
| 786 | "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, |
| 787 | # authorize the sharing of information from the given Floodlight |
| 788 | # configuration to this Display & Video 360 advertiser. |
| 789 | "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM. |
| 790 | "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 |
| 791 | # advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 792 | }, |
| 793 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 794 | "displayName": "A String", # Required. The display name of the advertiser. |
| 795 | # |
| 796 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 797 | "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 798 | "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. |
| 799 | # |
| 800 | # Accepted codes and the currencies they represent are: |
| 801 | # |
| 802 | # Currency Code : Currency Name |
| 803 | # |
| 804 | # * `ARS` : Argentine Peso |
| 805 | # * `AUD` : Australian Dollar |
| 806 | # * `BRL` : Brazilian Real |
| 807 | # * `CAD` : Canadian Dollar |
| 808 | # * `CHF` : Swiss Franc |
| 809 | # * `CLP` : Chilean Peso |
| 810 | # * `CNY` : Chinese Yuan |
| 811 | # * `COP` : Colombian Peso |
| 812 | # * `CZK` : Czech Koruna |
| 813 | # * `DKK` : Danish Krone |
| 814 | # * `EGP` : Egyption Pound |
| 815 | # * `EUR` : Euro |
| 816 | # * `GBP` : British Pound |
| 817 | # * `HKD` : Hong Kong Dollar |
| 818 | # * `HUF` : Hungarian Forint |
| 819 | # * `IDR` : Indonesian Rupiah |
| 820 | # * `ILS` : Israeli Shekel |
| 821 | # * `INR` : Indian Rupee |
| 822 | # * `JPY` : Japanese Yen |
| 823 | # * `KRW` : South Korean Won |
| 824 | # * `MXN` : Mexican Pesos |
| 825 | # * `MYR` : Malaysian Ringgit |
| 826 | # * `NGN` : Nigerian Naira |
| 827 | # * `NOK` : Norwegian Krone |
| 828 | # * `NZD` : New Zealand Dollar |
| 829 | # * `PEN` : Peruvian Nuevo Sol |
| 830 | # * `PLN` : Polish Zloty |
| 831 | # * `RON` : New Romanian Leu |
| 832 | # * `RUB` : Russian Ruble |
| 833 | # * `SEK` : Swedish Krona |
| 834 | # * `TRY` : Turkish Lira |
| 835 | # * `TWD` : New Taiwan Dollar |
| 836 | # * `USD` : US Dollar |
| 837 | # * `ZAR` : South African Rand |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 838 | "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. |
| 839 | # The system will send this information to publishers that require website |
| 840 | # URL to associate a campaign with an advertiser. |
| 841 | # |
| 842 | # Provide a URL with no path or query string, beginning with `http:` or |
| 843 | # `https:`. |
| 844 | # For example, http://www.example.com |
| 845 | "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. |
| 846 | # For example, `America/New_York`. |
| 847 | # |
| 848 | # See more at: |
| 849 | # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
| 850 | # |
| 851 | # For CM hybrid advertisers, the time zone is the same as that of the |
| 852 | # associated CM account; for third-party only advertisers, the time zone is |
| 853 | # the same as that of the parent partner. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 854 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 855 | "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed. |
| 856 | "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. |
| 857 | # |
| 858 | # If not specified, the SDF settings of the parent partner are used. |
| 859 | "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. |
| 860 | # |
| 861 | # * Required when |
| 862 | # overridePartnerSdfConfig |
| 863 | # is `true`. |
| 864 | # * Output only when |
| 865 | # overridePartnerSdfConfig |
| 866 | # is `false`. |
| 867 | "version": "A String", # Required. The version of SDF being used. |
| 868 | "adminEmail": "A String", # An administrator email address to which the SDF processing status reports |
| 869 | # will be sent. |
| 870 | }, |
| 871 | "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its |
| 872 | # parent partner. |
| 873 | # |
| 874 | # By default, an advertiser inherits the SDF configuration from the parent |
| 875 | # partner. To override the partner configuration, set this field to `true` |
| 876 | # and provide the new configuration in |
| 877 | # sdfConfig. |
| 878 | }, |
| 879 | }, |
| 880 | "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the |
| 881 | # advertiser can spend their budgets and bid on inventory. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 882 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 883 | # * Accepted values are `ENTITY_STATUS_ACTIVE` and |
| 884 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. |
| 885 | # * If set to |
| 886 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 |
| 887 | # days from when it was first scheduled for deletion. |
| 888 | "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. |
| 889 | "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. |
| 890 | "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA) |
| 891 | # compliance. |
| 892 | # |
| 893 | # Warning: Changing OBA settings may cause the audit status of your creatives |
| 894 | # to be reset by some ad exchanges, making them ineligible to serve until |
| 895 | # they are re-approved. |
| 896 | "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, |
| 897 | # authorize Google to use video creatives associated with this Display & |
| 898 | # Video 360 advertiser to provide reporting and features related to the |
| 899 | # advertiser's television campaigns. |
| 900 | # |
| 901 | # Applicable only when the advertiser has a |
| 902 | # CM hybrid ad server |
| 903 | # configuration. |
| 904 | "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service |
| 905 | # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag |
| 906 | # containing this ID to the creative tag. |
| 907 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 908 | }, |
| 909 | ], |
| 910 | "nextPageToken": "A String", # A token to retrieve the next page of results. |
| 911 | # Pass this value in the |
| 912 | # page_token |
| 913 | # field in the subsequent call to `ListAdvertisers` method to retrieve the |
| 914 | # next page of results. |
| 915 | }</pre> |
| 916 | </div> |
| 917 | |
| 918 | <div class="method"> |
| 919 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 920 | <pre>Retrieves the next page of results. |
| 921 | |
| 922 | Args: |
| 923 | previous_request: The request for the previous page. (required) |
| 924 | previous_response: The response from the request for the previous page. (required) |
| 925 | |
| 926 | Returns: |
| 927 | A request object that you can call 'execute()' on to request the next |
| 928 | page. Returns None if there are no more items in the collection. |
| 929 | </pre> |
| 930 | </div> |
| 931 | |
| 932 | <div class="method"> |
| 933 | <code class="details" id="patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</code> |
| 934 | <pre>Updates an existing advertiser. |
| 935 | Returns the updated advertiser if successful. |
| 936 | |
| 937 | Args: |
| 938 | advertiserId: string, Output only. The unique ID of the advertiser. Assigned by the system. (required) |
| 939 | body: object, The request body. |
| 940 | The object takes the form of: |
| 941 | |
| 942 | { # A single advertiser in Display & Video 360 (DV360). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 943 | "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 944 | "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 945 | "name": "A String", # Output only. The resource name of the advertiser. |
| 946 | "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. |
| 947 | # Only integrationCode is currently |
| 948 | # applicable to advertiser. Other fields of IntegrationDetails are not |
| 949 | # supported and will be ignored if provided. |
| 950 | "details": "A String", # Additional details of the entry in string format. |
| 951 | # |
| 952 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 953 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 954 | # The integration code will show up together with the entry in many |
| 955 | # places in the system, for example, reporting. |
| 956 | # |
| 957 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 958 | }, |
| 959 | "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. |
| 960 | "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 961 | "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers |
| 962 | # only. |
| 963 | "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. |
| 964 | # This value cannot be changed once set to `true`. |
| 965 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 966 | "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and |
| 967 | # third-party ad servers. |
| 968 | # ad servers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 969 | "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports. |
| 970 | "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives. |
| 971 | # |
| 972 | # If absent or empty in |
| 973 | # CreateAdvertiser method, the system |
| 974 | # will automatically create a CM site. |
| 975 | # |
| 976 | # Removing sites from this list may cause DV360 creatives synced from CM to |
| 977 | # be deleted. At least one site must be specified. |
| 978 | "A String", |
| 979 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 980 | "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser. |
| 981 | "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, |
| 982 | # authorize the sharing of information from the given Floodlight |
| 983 | # configuration to this Display & Video 360 advertiser. |
| 984 | "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM. |
| 985 | "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 |
| 986 | # advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 987 | }, |
| 988 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 989 | "displayName": "A String", # Required. The display name of the advertiser. |
| 990 | # |
| 991 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 992 | "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 993 | "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. |
| 994 | # |
| 995 | # Accepted codes and the currencies they represent are: |
| 996 | # |
| 997 | # Currency Code : Currency Name |
| 998 | # |
| 999 | # * `ARS` : Argentine Peso |
| 1000 | # * `AUD` : Australian Dollar |
| 1001 | # * `BRL` : Brazilian Real |
| 1002 | # * `CAD` : Canadian Dollar |
| 1003 | # * `CHF` : Swiss Franc |
| 1004 | # * `CLP` : Chilean Peso |
| 1005 | # * `CNY` : Chinese Yuan |
| 1006 | # * `COP` : Colombian Peso |
| 1007 | # * `CZK` : Czech Koruna |
| 1008 | # * `DKK` : Danish Krone |
| 1009 | # * `EGP` : Egyption Pound |
| 1010 | # * `EUR` : Euro |
| 1011 | # * `GBP` : British Pound |
| 1012 | # * `HKD` : Hong Kong Dollar |
| 1013 | # * `HUF` : Hungarian Forint |
| 1014 | # * `IDR` : Indonesian Rupiah |
| 1015 | # * `ILS` : Israeli Shekel |
| 1016 | # * `INR` : Indian Rupee |
| 1017 | # * `JPY` : Japanese Yen |
| 1018 | # * `KRW` : South Korean Won |
| 1019 | # * `MXN` : Mexican Pesos |
| 1020 | # * `MYR` : Malaysian Ringgit |
| 1021 | # * `NGN` : Nigerian Naira |
| 1022 | # * `NOK` : Norwegian Krone |
| 1023 | # * `NZD` : New Zealand Dollar |
| 1024 | # * `PEN` : Peruvian Nuevo Sol |
| 1025 | # * `PLN` : Polish Zloty |
| 1026 | # * `RON` : New Romanian Leu |
| 1027 | # * `RUB` : Russian Ruble |
| 1028 | # * `SEK` : Swedish Krona |
| 1029 | # * `TRY` : Turkish Lira |
| 1030 | # * `TWD` : New Taiwan Dollar |
| 1031 | # * `USD` : US Dollar |
| 1032 | # * `ZAR` : South African Rand |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1033 | "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. |
| 1034 | # The system will send this information to publishers that require website |
| 1035 | # URL to associate a campaign with an advertiser. |
| 1036 | # |
| 1037 | # Provide a URL with no path or query string, beginning with `http:` or |
| 1038 | # `https:`. |
| 1039 | # For example, http://www.example.com |
| 1040 | "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. |
| 1041 | # For example, `America/New_York`. |
| 1042 | # |
| 1043 | # See more at: |
| 1044 | # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
| 1045 | # |
| 1046 | # For CM hybrid advertisers, the time zone is the same as that of the |
| 1047 | # associated CM account; for third-party only advertisers, the time zone is |
| 1048 | # the same as that of the parent partner. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1049 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1050 | "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed. |
| 1051 | "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. |
| 1052 | # |
| 1053 | # If not specified, the SDF settings of the parent partner are used. |
| 1054 | "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. |
| 1055 | # |
| 1056 | # * Required when |
| 1057 | # overridePartnerSdfConfig |
| 1058 | # is `true`. |
| 1059 | # * Output only when |
| 1060 | # overridePartnerSdfConfig |
| 1061 | # is `false`. |
| 1062 | "version": "A String", # Required. The version of SDF being used. |
| 1063 | "adminEmail": "A String", # An administrator email address to which the SDF processing status reports |
| 1064 | # will be sent. |
| 1065 | }, |
| 1066 | "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its |
| 1067 | # parent partner. |
| 1068 | # |
| 1069 | # By default, an advertiser inherits the SDF configuration from the parent |
| 1070 | # partner. To override the partner configuration, set this field to `true` |
| 1071 | # and provide the new configuration in |
| 1072 | # sdfConfig. |
| 1073 | }, |
| 1074 | }, |
| 1075 | "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the |
| 1076 | # advertiser can spend their budgets and bid on inventory. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1077 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1078 | # * Accepted values are `ENTITY_STATUS_ACTIVE` and |
| 1079 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. |
| 1080 | # * If set to |
| 1081 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 |
| 1082 | # days from when it was first scheduled for deletion. |
| 1083 | "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. |
| 1084 | "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. |
| 1085 | "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA) |
| 1086 | # compliance. |
| 1087 | # |
| 1088 | # Warning: Changing OBA settings may cause the audit status of your creatives |
| 1089 | # to be reset by some ad exchanges, making them ineligible to serve until |
| 1090 | # they are re-approved. |
| 1091 | "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, |
| 1092 | # authorize Google to use video creatives associated with this Display & |
| 1093 | # Video 360 advertiser to provide reporting and features related to the |
| 1094 | # advertiser's television campaigns. |
| 1095 | # |
| 1096 | # Applicable only when the advertiser has a |
| 1097 | # CM hybrid ad server |
| 1098 | # configuration. |
| 1099 | "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service |
| 1100 | # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag |
| 1101 | # containing this ID to the creative tag. |
| 1102 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1103 | } |
| 1104 | |
| 1105 | updateMask: string, Required. The mask to control which fields to update. |
| 1106 | x__xgafv: string, V1 error format. |
| 1107 | Allowed values |
| 1108 | 1 - v1 error format |
| 1109 | 2 - v2 error format |
| 1110 | |
| 1111 | Returns: |
| 1112 | An object of the form: |
| 1113 | |
| 1114 | { # A single advertiser in Display & Video 360 (DV360). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1115 | "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1116 | "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1117 | "name": "A String", # Output only. The resource name of the advertiser. |
| 1118 | "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser. |
| 1119 | # Only integrationCode is currently |
| 1120 | # applicable to advertiser. Other fields of IntegrationDetails are not |
| 1121 | # supported and will be ignored if provided. |
| 1122 | "details": "A String", # Additional details of the entry in string format. |
| 1123 | # |
| 1124 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 1125 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 1126 | # The integration code will show up together with the entry in many |
| 1127 | # places in the system, for example, reporting. |
| 1128 | # |
| 1129 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 1130 | }, |
| 1131 | "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. |
| 1132 | "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1133 | "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers |
| 1134 | # only. |
| 1135 | "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled. |
| 1136 | # This value cannot be changed once set to `true`. |
| 1137 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1138 | "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and |
| 1139 | # third-party ad servers. |
| 1140 | # ad servers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1141 | "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports. |
| 1142 | "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives. |
| 1143 | # |
| 1144 | # If absent or empty in |
| 1145 | # CreateAdvertiser method, the system |
| 1146 | # will automatically create a CM site. |
| 1147 | # |
| 1148 | # Removing sites from this list may cause DV360 creatives synced from CM to |
| 1149 | # be deleted. At least one site must be specified. |
| 1150 | "A String", |
| 1151 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1152 | "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser. |
| 1153 | "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company, |
| 1154 | # authorize the sharing of information from the given Floodlight |
| 1155 | # configuration to this Display & Video 360 advertiser. |
| 1156 | "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM. |
| 1157 | "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 |
| 1158 | # advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1159 | }, |
| 1160 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1161 | "displayName": "A String", # Required. The display name of the advertiser. |
| 1162 | # |
| 1163 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1164 | "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1165 | "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format. |
| 1166 | # |
| 1167 | # Accepted codes and the currencies they represent are: |
| 1168 | # |
| 1169 | # Currency Code : Currency Name |
| 1170 | # |
| 1171 | # * `ARS` : Argentine Peso |
| 1172 | # * `AUD` : Australian Dollar |
| 1173 | # * `BRL` : Brazilian Real |
| 1174 | # * `CAD` : Canadian Dollar |
| 1175 | # * `CHF` : Swiss Franc |
| 1176 | # * `CLP` : Chilean Peso |
| 1177 | # * `CNY` : Chinese Yuan |
| 1178 | # * `COP` : Colombian Peso |
| 1179 | # * `CZK` : Czech Koruna |
| 1180 | # * `DKK` : Danish Krone |
| 1181 | # * `EGP` : Egyption Pound |
| 1182 | # * `EUR` : Euro |
| 1183 | # * `GBP` : British Pound |
| 1184 | # * `HKD` : Hong Kong Dollar |
| 1185 | # * `HUF` : Hungarian Forint |
| 1186 | # * `IDR` : Indonesian Rupiah |
| 1187 | # * `ILS` : Israeli Shekel |
| 1188 | # * `INR` : Indian Rupee |
| 1189 | # * `JPY` : Japanese Yen |
| 1190 | # * `KRW` : South Korean Won |
| 1191 | # * `MXN` : Mexican Pesos |
| 1192 | # * `MYR` : Malaysian Ringgit |
| 1193 | # * `NGN` : Nigerian Naira |
| 1194 | # * `NOK` : Norwegian Krone |
| 1195 | # * `NZD` : New Zealand Dollar |
| 1196 | # * `PEN` : Peruvian Nuevo Sol |
| 1197 | # * `PLN` : Polish Zloty |
| 1198 | # * `RON` : New Romanian Leu |
| 1199 | # * `RUB` : Russian Ruble |
| 1200 | # * `SEK` : Swedish Krona |
| 1201 | # * `TRY` : Turkish Lira |
| 1202 | # * `TWD` : New Taiwan Dollar |
| 1203 | # * `USD` : US Dollar |
| 1204 | # * `ZAR` : South African Rand |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1205 | "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website. |
| 1206 | # The system will send this information to publishers that require website |
| 1207 | # URL to associate a campaign with an advertiser. |
| 1208 | # |
| 1209 | # Provide a URL with no path or query string, beginning with `http:` or |
| 1210 | # `https:`. |
| 1211 | # For example, http://www.example.com |
| 1212 | "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone. |
| 1213 | # For example, `America/New_York`. |
| 1214 | # |
| 1215 | # See more at: |
| 1216 | # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
| 1217 | # |
| 1218 | # For CM hybrid advertisers, the time zone is the same as that of the |
| 1219 | # associated CM account; for third-party only advertisers, the time zone is |
| 1220 | # the same as that of the parent partner. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1221 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1222 | "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed. |
| 1223 | "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser. |
| 1224 | # |
| 1225 | # If not specified, the SDF settings of the parent partner are used. |
| 1226 | "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser. |
| 1227 | # |
| 1228 | # * Required when |
| 1229 | # overridePartnerSdfConfig |
| 1230 | # is `true`. |
| 1231 | # * Output only when |
| 1232 | # overridePartnerSdfConfig |
| 1233 | # is `false`. |
| 1234 | "version": "A String", # Required. The version of SDF being used. |
| 1235 | "adminEmail": "A String", # An administrator email address to which the SDF processing status reports |
| 1236 | # will be sent. |
| 1237 | }, |
| 1238 | "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its |
| 1239 | # parent partner. |
| 1240 | # |
| 1241 | # By default, an advertiser inherits the SDF configuration from the parent |
| 1242 | # partner. To override the partner configuration, set this field to `true` |
| 1243 | # and provide the new configuration in |
| 1244 | # sdfConfig. |
| 1245 | }, |
| 1246 | }, |
| 1247 | "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the |
| 1248 | # advertiser can spend their budgets and bid on inventory. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1249 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1250 | # * Accepted values are `ENTITY_STATUS_ACTIVE` and |
| 1251 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. |
| 1252 | # * If set to |
| 1253 | # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 |
| 1254 | # days from when it was first scheduled for deletion. |
| 1255 | "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser. |
| 1256 | "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives. |
| 1257 | "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA) |
| 1258 | # compliance. |
| 1259 | # |
| 1260 | # Warning: Changing OBA settings may cause the audit status of your creatives |
| 1261 | # to be reset by some ad exchanges, making them ineligible to serve until |
| 1262 | # they are re-approved. |
| 1263 | "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company, |
| 1264 | # authorize Google to use video creatives associated with this Display & |
| 1265 | # Video 360 advertiser to provide reporting and features related to the |
| 1266 | # advertiser's television campaigns. |
| 1267 | # |
| 1268 | # Applicable only when the advertiser has a |
| 1269 | # CM hybrid ad server |
| 1270 | # configuration. |
| 1271 | "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service |
| 1272 | # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag |
| 1273 | # containing this ID to the creative tag. |
| 1274 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1275 | }</pre> |
| 1276 | </div> |
| 1277 | |
| 1278 | </body></html> |