• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dfareporting_v3_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_1.campaignCreativeAssociations.html">campaignCreativeAssociations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#insert">insert(profileId, campaignId, body)</a></code></p>
79<p class="firstline">Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.</p>
80<p class="toc_element">
81  <code><a href="#list">list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)</a></code></p>
82<p class="firstline">Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="insert">insert(profileId, campaignId, body)</code>
89  <pre>Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.
90
91Args:
92  profileId: string, User profile ID associated with this request. (required)
93  campaignId: string, Campaign ID in this association. (required)
94  body: object, The request body. (required)
95    The object takes the form of:
96
97{ # Identifies a creative which has been associated with a given campaign.
98    "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
99    "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
100  }
101
102
103Returns:
104  An object of the form:
105
106    { # Identifies a creative which has been associated with a given campaign.
107      "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
108      "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
109    }</pre>
110</div>
111
112<div class="method">
113    <code class="details" id="list">list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)</code>
114  <pre>Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
115
116Args:
117  profileId: string, User profile ID associated with this request. (required)
118  campaignId: string, Campaign ID in this association. (required)
119  maxResults: integer, Maximum number of results to return.
120  pageToken: string, Value of the nextPageToken from the previous result page.
121  sortOrder: string, Order of sorted results.
122    Allowed values
123      ASCENDING -
124      DESCENDING -
125
126Returns:
127  An object of the form:
128
129    { # Campaign Creative Association List Response
130    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
131    "campaignCreativeAssociations": [ # Campaign creative association collection
132      { # Identifies a creative which has been associated with a given campaign.
133          "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
134          "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
135        },
136    ],
137    "kind": "dfareporting#campaignCreativeAssociationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
138  }</pre>
139</div>
140
141<div class="method">
142    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
143  <pre>Retrieves the next page of results.
144
145Args:
146  previous_request: The request for the previous page. (required)
147  previous_response: The response from the request for the previous page. (required)
148
149Returns:
150  A request object that you can call 'execute()' on to request the next
151  page. Returns None if there are no more items in the collection.
152    </pre>
153</div>
154
155</body></html>