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_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.dynamicTargetingKeys.html">dynamicTargetingKeys</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(profileId, objectId, name, objectType)</a></code></p>
79<p class="firstline">Deletes an existing dynamic targeting key.</p>
80<p class="toc_element">
81  <code><a href="#insert">insert(profileId, body)</a></code></p>
82<p class="firstline">Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.</p>
83<p class="toc_element">
84  <code><a href="#list">list(profileId, advertiserId=None, objectId=None, names=None, objectType=None)</a></code></p>
85<p class="firstline">Retrieves a list of dynamic targeting keys.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="delete">delete(profileId, objectId, name, objectType)</code>
89  <pre>Deletes an existing dynamic targeting key.
90
91Args:
92  profileId: string, User profile ID associated with this request. (required)
93  objectId: string, ID of the object of this dynamic targeting key. This is a required field. (required)
94  name: string, Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. (required)
95  objectType: string, Type of the object of this dynamic targeting key. This is a required field. (required)
96    Allowed values
97      OBJECT_AD -
98      OBJECT_ADVERTISER -
99      OBJECT_CREATIVE -
100      OBJECT_PLACEMENT -
101</pre>
102</div>
103
104<div class="method">
105    <code class="details" id="insert">insert(profileId, body)</code>
106  <pre>Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.
107
108Args:
109  profileId: string, User profile ID associated with this request. (required)
110  body: object, The request body. (required)
111    The object takes the form of:
112
113{ # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
114    "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
115    "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
116    "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
117    "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
118  }
119
120
121Returns:
122  An object of the form:
123
124    { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
125      "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
126      "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
127      "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
128      "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
129    }</pre>
130</div>
131
132<div class="method">
133    <code class="details" id="list">list(profileId, advertiserId=None, objectId=None, names=None, objectType=None)</code>
134  <pre>Retrieves a list of dynamic targeting keys.
135
136Args:
137  profileId: string, User profile ID associated with this request. (required)
138  advertiserId: string, Select only dynamic targeting keys whose object has this advertiser ID.
139  objectId: string, Select only dynamic targeting keys with this object ID.
140  names: string, Select only dynamic targeting keys exactly matching these names. (repeated)
141  objectType: string, Select only dynamic targeting keys with this object type.
142    Allowed values
143      OBJECT_AD -
144      OBJECT_ADVERTISER -
145      OBJECT_CREATIVE -
146      OBJECT_PLACEMENT -
147
148Returns:
149  An object of the form:
150
151    { # Dynamic Targeting Key List Response
152    "kind": "dfareporting#dynamicTargetingKeysListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse".
153    "dynamicTargetingKeys": [ # Dynamic targeting key collection.
154      { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
155          "kind": "dfareporting#dynamicTargetingKey", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
156          "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
157          "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
158          "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
159        },
160    ],
161  }</pre>
162</div>
163
164</body></html>