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
|
<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_5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_5.dynamicTargetingKeys.html">dynamicTargetingKeys</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(profileId, objectId, name, objectType, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing dynamic targeting key.</p>
<p class="toc_element">
<code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#list">list(profileId, advertiserId=None, names=None, objectId=None, objectType=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of dynamic targeting keys.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(profileId, objectId, name, objectType, x__xgafv=None)</code>
<pre>Deletes an existing dynamic targeting key.
Args:
profileId: string, User profile ID associated with this request. (required)
objectId: string, ID of the object of this dynamic targeting key. This is a required field. (required)
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)
objectType: string, Type of the object of this dynamic targeting key. This is a required field. (required)
Allowed values
OBJECT_ADVERTISER -
OBJECT_AD -
OBJECT_CREATIVE -
OBJECT_PLACEMENT -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
<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.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # 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 Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
"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.
"objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
"objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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 Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
"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.
"objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
"objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, advertiserId=None, names=None, objectId=None, objectType=None, x__xgafv=None)</code>
<pre>Retrieves a list of dynamic targeting keys.
Args:
profileId: string, User profile ID associated with this request. (required)
advertiserId: string, Select only dynamic targeting keys whose object has this advertiser ID.
names: string, Select only dynamic targeting keys exactly matching these names. (repeated)
objectId: string, Select only dynamic targeting keys with this object ID.
objectType: string, Select only dynamic targeting keys with this object type.
Allowed values
OBJECT_ADVERTISER -
OBJECT_AD -
OBJECT_CREATIVE -
OBJECT_PLACEMENT -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Dynamic Targeting Key List Response
"dynamicTargetingKeys": [ # Dynamic targeting key collection.
{ # 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 Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
"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.
"objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
"objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse".
}</pre>
</div>
</body></html>
|
