1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dfareporting_v3_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_2.floodlightActivities.html">floodlightActivities</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(profileId, id)</a></code></p>
<p class="firstline">Deletes an existing floodlight activity.</p>
<p class="toc_element">
<code><a href="#generatetag">generatetag(profileId, floodlightActivityId=None)</a></code></p>
<p class="firstline">Generates a tag for a floodlight activity.</p>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
<p class="firstline">Gets one floodlight activity by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(profileId, body)</a></code></p>
<p class="firstline">Inserts a new floodlight activity.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)</a></code></p>
<p class="firstline">Retrieves a list of floodlight activities, possibly filtered. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(profileId, id, body)</a></code></p>
<p class="firstline">Updates an existing floodlight activity. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, body)</a></code></p>
<p class="firstline">Updates an existing floodlight activity.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(profileId, id)</code>
<pre>Deletes an existing floodlight activity.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Floodlight activity ID. (required)
</pre>
</div>
<div class="method">
<code class="details" id="generatetag">generatetag(profileId, floodlightActivityId=None)</code>
<pre>Generates a tag for a floodlight activity.
Args:
profileId: string, User profile ID associated with this request. (required)
floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.
Returns:
An object of the form:
{ # Floodlight Activity GenerateTag Response
"globalSiteTagGlobalSnippet": "A String", # The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.
"floodlightActivityTag": "A String", # Generated tag for this Floodlight activity. For global site tags, this is the event snippet.
"kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(profileId, id)</code>
<pre>Gets one floodlight activity by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Floodlight activity ID. (required)
Returns:
An object of the form:
{ # Contains properties of a Floodlight activity.
"tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
"secure": True or False, # Whether this tag should use SSL.
"floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
"advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
"tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
"id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
"floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
"publisherTags": [ # Publisher dynamic floodlight tags.
{ # Publisher Dynamic Tag
"viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
"clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
"siteId": "A String", # Site ID of this dynamic tag.
"dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
"directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
"floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
"accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
"subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
"userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type.
# Acceptable values are U1 to U100, inclusive.
"A String",
],
"defaultTags": [ # Dynamic floodlight tags.
{ # Dynamic Tag
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
],
"countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
"floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(profileId, body)</code>
<pre>Inserts a new floodlight activity.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a Floodlight activity.
"tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
"secure": True or False, # Whether this tag should use SSL.
"floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
"advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
"tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
"id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
"floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
"publisherTags": [ # Publisher dynamic floodlight tags.
{ # Publisher Dynamic Tag
"viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
"clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
"siteId": "A String", # Site ID of this dynamic tag.
"dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
"directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
"floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
"accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
"subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
"userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type.
# Acceptable values are U1 to U100, inclusive.
"A String",
],
"defaultTags": [ # Dynamic floodlight tags.
{ # Dynamic Tag
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
],
"countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
"floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
}
Returns:
An object of the form:
{ # Contains properties of a Floodlight activity.
"tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
"secure": True or False, # Whether this tag should use SSL.
"floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
"advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
"tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
"id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
"floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
"publisherTags": [ # Publisher dynamic floodlight tags.
{ # Publisher Dynamic Tag
"viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
"clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
"siteId": "A String", # Site ID of this dynamic tag.
"dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
"directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
"floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
"accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
"subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
"userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type.
# Acceptable values are U1 to U100, inclusive.
"A String",
],
"defaultTags": [ # Dynamic floodlight tags.
{ # Dynamic Tag
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
],
"countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
"floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)</code>
<pre>Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
tagString: string, Select only floodlight activities with the specified tag string.
floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
pageToken: string, Value of the nextPageToken from the previous result page.
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
maxResults: integer, Maximum number of results to return.
searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 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 "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
Allowed values
COUNTER -
SALE -
Returns:
An object of the form:
{ # Floodlight Activity List Response
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
"floodlightActivities": [ # Floodlight activity collection.
{ # Contains properties of a Floodlight activity.
"tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
"secure": True or False, # Whether this tag should use SSL.
"floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
"advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
"tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
"id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
"floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
"publisherTags": [ # Publisher dynamic floodlight tags.
{ # Publisher Dynamic Tag
"viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
"clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
"siteId": "A String", # Site ID of this dynamic tag.
"dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
"directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
"floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
"accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
"subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
"userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type.
# Acceptable values are U1 to U100, inclusive.
"A String",
],
"defaultTags": [ # Dynamic floodlight tags.
{ # Dynamic Tag
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
],
"countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
"floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(profileId, id, body)</code>
<pre>Updates an existing floodlight activity. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Floodlight activity ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a Floodlight activity.
"tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
"secure": True or False, # Whether this tag should use SSL.
"floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
"advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
"tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
"id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
"floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
"publisherTags": [ # Publisher dynamic floodlight tags.
{ # Publisher Dynamic Tag
"viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
"clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
"siteId": "A String", # Site ID of this dynamic tag.
"dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
"directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
"floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
"accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
"subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
"userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type.
# Acceptable values are U1 to U100, inclusive.
"A String",
],
"defaultTags": [ # Dynamic floodlight tags.
{ # Dynamic Tag
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
],
"countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
"floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
}
Returns:
An object of the form:
{ # Contains properties of a Floodlight activity.
"tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
"secure": True or False, # Whether this tag should use SSL.
"floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
"advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
"tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
"id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
"floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
"publisherTags": [ # Publisher dynamic floodlight tags.
{ # Publisher Dynamic Tag
"viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
"clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
"siteId": "A String", # Site ID of this dynamic tag.
"dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
"directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
"floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
"accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
"subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
"userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type.
# Acceptable values are U1 to U100, inclusive.
"A String",
],
"defaultTags": [ # Dynamic floodlight tags.
{ # Dynamic Tag
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
],
"countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
"floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(profileId, body)</code>
<pre>Updates an existing floodlight activity.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a Floodlight activity.
"tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
"secure": True or False, # Whether this tag should use SSL.
"floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
"advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
"tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
"id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
"floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
"publisherTags": [ # Publisher dynamic floodlight tags.
{ # Publisher Dynamic Tag
"viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
"clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
"siteId": "A String", # Site ID of this dynamic tag.
"dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
"directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
"floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
"accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
"subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
"userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type.
# Acceptable values are U1 to U100, inclusive.
"A String",
],
"defaultTags": [ # Dynamic floodlight tags.
{ # Dynamic Tag
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
],
"countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
"floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
}
Returns:
An object of the form:
{ # Contains properties of a Floodlight activity.
"tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
"secure": True or False, # Whether this tag should use SSL.
"floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
"advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
"tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
"id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
"floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
"publisherTags": [ # Publisher dynamic floodlight tags.
{ # Publisher Dynamic Tag
"viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
"clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
"siteId": "A String", # Site ID of this dynamic tag.
"dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
"directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
"siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
},
],
"sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
"floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"hidden": True or False, # Whether this activity is archived.
"accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
"sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
"floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
"expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
"cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
"kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
"subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
"name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
"notes": "A String", # General notes or implementation instructions for the tag.
"floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
"userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type.
# Acceptable values are U1 to U100, inclusive.
"A String",
],
"defaultTags": [ # Dynamic floodlight tags.
{ # Dynamic Tag
"tag": "A String", # Tag code.
"id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
"name": "A String", # Name of this tag.
},
],
"countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
"floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
}</pre>
</div>
</body></html>
|