Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4c9ccb08aa866b5402c5e63c70306b5a3c121ba1 / . / docs / dyn / dfareporting_v3_5.dynamicTargetingKeys.html
blob: dc83c33357fc14e6f5a3e57e346e5fdec995d9c8 [file] [log] [blame]
yoshi-code-bot108b8192021-05-23 03:48:02 -0700[diff] [blame]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_5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_5.dynamicTargetingKeys.html">dynamicTargetingKeys</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(profileId, objectId, name, objectType, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an existing dynamic targeting key.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
85<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>
86<p class="toc_element">
87 <code><a href="#list">list(profileId, advertiserId=None, names=None, objectId=None, objectType=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Retrieves a list of dynamic targeting keys.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
96 <code class="details" id="delete">delete(profileId, objectId, name, objectType, x__xgafv=None)</code>
97 <pre>Deletes an existing dynamic targeting key.
98
99Args:
100 profileId: string, User profile ID associated with this request. (required)
101 objectId: string, ID of the object of this dynamic targeting key. This is a required field. (required)
102 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)
103 objectType: string, Type of the object of this dynamic targeting key. This is a required field. (required)
104 Allowed values
105 OBJECT_ADVERTISER -
106 OBJECT_AD -
107 OBJECT_CREATIVE -
108 OBJECT_PLACEMENT -
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113</pre>
114</div>
115
116<div class="method">
117 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
118 <pre>Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser&#x27;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.
119
120Args:
121 profileId: string, User profile ID associated with this request. (required)
122 body: object, The request body.
123 The object takes the form of:
124
125{ # 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.
126 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#dynamicTargetingKey&quot;.
127 &quot;name&quot;: &quot;A String&quot;, # 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.
128 &quot;objectId&quot;: &quot;A String&quot;, # ID of the object of this dynamic targeting key. This is a required field.
129 &quot;objectType&quot;: &quot;A String&quot;, # Type of the object of this dynamic targeting key. This is a required field.
130}
131
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
140 { # 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.
141 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#dynamicTargetingKey&quot;.
142 &quot;name&quot;: &quot;A String&quot;, # 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.
143 &quot;objectId&quot;: &quot;A String&quot;, # ID of the object of this dynamic targeting key. This is a required field.
144 &quot;objectType&quot;: &quot;A String&quot;, # Type of the object of this dynamic targeting key. This is a required field.
145}</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="list">list(profileId, advertiserId=None, names=None, objectId=None, objectType=None, x__xgafv=None)</code>
150 <pre>Retrieves a list of dynamic targeting keys.
151
152Args:
153 profileId: string, User profile ID associated with this request. (required)
154 advertiserId: string, Select only dynamic targeting keys whose object has this advertiser ID.
155 names: string, Select only dynamic targeting keys exactly matching these names. (repeated)
156 objectId: string, Select only dynamic targeting keys with this object ID.
157 objectType: string, Select only dynamic targeting keys with this object type.
158 Allowed values
159 OBJECT_ADVERTISER -
160 OBJECT_AD -
161 OBJECT_CREATIVE -
162 OBJECT_PLACEMENT -
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168Returns:
169 An object of the form:
170
171 { # Dynamic Targeting Key List Response
172 &quot;dynamicTargetingKeys&quot;: [ # Dynamic targeting key collection.
173 { # 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.
174 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#dynamicTargetingKey&quot;.
175 &quot;name&quot;: &quot;A String&quot;, # 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.
176 &quot;objectId&quot;: &quot;A String&quot;, # ID of the object of this dynamic targeting key. This is a required field.
177 &quot;objectType&quot;: &quot;A String&quot;, # Type of the object of this dynamic targeting key. This is a required field.
178 },
179 ],
180 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#dynamicTargetingKeysListResponse&quot;.
181}</pre>
182</div>
183
184</body></html>