File: youtube_v3.thirdPartyLinks.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (297 lines) | stat: -rw-r--r-- 16,171 bytes parent folder | download | duplicates (3)
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
<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="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.thirdPartyLinks.html">thirdPartyLinks</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(linkingToken, type, externalChannelId=None, part=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a resource.</p>
<p class="toc_element">
  <code><a href="#insert">insert(part, body=None, externalChannelId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new resource into this collection.</p>
<p class="toc_element">
  <code><a href="#list">list(part, externalChannelId=None, linkingToken=None, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
<p class="toc_element">
  <code><a href="#update">update(part, body=None, externalChannelId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing resource.</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(linkingToken, type, externalChannelId=None, part=None, x__xgafv=None)</code>
  <pre>Deletes a resource.

Args:
  linkingToken: string, Delete the partner links with the given linking token. (required)
  type: string, Type of the link to be deleted. (required)
    Allowed values
      linkUnspecified - 
      channelToStoreLink - A link that is connecting (or about to connect) a channel with a store on a merchandising platform in order to enable retail commerce capabilities for that channel on YouTube.
  externalChannelId: string, Channel ID to which changes should be applied, for delegation.
  part: string, Do not use. Required for compatibility. (repeated)
  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(part, body=None, externalChannelId=None, x__xgafv=None)</code>
  <pre>Inserts a new resource into this collection.

Args:
  part: string, The *part* parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet. (required) (repeated)
  body: object, The request body.
    The object takes the form of:

{ # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
  &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
  &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
  &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
  &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
    &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
      &quot;billingDetails&quot;: { # Information specific to billing. # Information specific to billing (read-only).
        &quot;billingStatus&quot;: &quot;A String&quot;, # The current billing profile status.
      },
      &quot;merchantAffiliateProgramDetails&quot;: { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
        &quot;status&quot;: &quot;A String&quot;, # The current merchant affiliate program status.
      },
      &quot;merchantId&quot;: &quot;A String&quot;, # Google Merchant Center id of the store.
      &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
      &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
    },
    &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
  },
  &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
    &quot;linkStatus&quot;: &quot;A String&quot;,
  },
}

  externalChannelId: string, Channel ID to which changes should be applied, for delegation.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
  &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
  &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
  &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
  &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
    &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
      &quot;billingDetails&quot;: { # Information specific to billing. # Information specific to billing (read-only).
        &quot;billingStatus&quot;: &quot;A String&quot;, # The current billing profile status.
      },
      &quot;merchantAffiliateProgramDetails&quot;: { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
        &quot;status&quot;: &quot;A String&quot;, # The current merchant affiliate program status.
      },
      &quot;merchantId&quot;: &quot;A String&quot;, # Google Merchant Center id of the store.
      &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
      &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
    },
    &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
  },
  &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
    &quot;linkStatus&quot;: &quot;A String&quot;,
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(part, externalChannelId=None, linkingToken=None, type=None, x__xgafv=None)</code>
  <pre>Retrieves a list of resources, possibly filtered.

Args:
  part: string, The *part* parameter specifies the thirdPartyLink resource parts that the API response will include. Supported values are linkingToken, status, and snippet. (required) (repeated)
  externalChannelId: string, Channel ID to which changes should be applied, for delegation.
  linkingToken: string, Get a third party link with the given linking token.
  type: string, Get a third party link of the given type.
    Allowed values
      linkUnspecified - 
      channelToStoreLink - A link that is connecting (or about to connect) a channel with a store on a merchandising platform in order to enable retail commerce capabilities for that channel on YouTube.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
  &quot;items&quot;: [
    { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
      &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
      &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
      &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
      &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
        &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
          &quot;billingDetails&quot;: { # Information specific to billing. # Information specific to billing (read-only).
            &quot;billingStatus&quot;: &quot;A String&quot;, # The current billing profile status.
          },
          &quot;merchantAffiliateProgramDetails&quot;: { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
            &quot;status&quot;: &quot;A String&quot;, # The current merchant affiliate program status.
          },
          &quot;merchantId&quot;: &quot;A String&quot;, # Google Merchant Center id of the store.
          &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
          &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
        },
        &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
      },
      &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
        &quot;linkStatus&quot;: &quot;A String&quot;,
      },
    },
  ],
  &quot;kind&quot;: &quot;youtube#thirdPartyLinkListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLinkListResponse&quot;.
}</pre>
</div>

<div class="method">
    <code class="details" id="update">update(part, body=None, externalChannelId=None, x__xgafv=None)</code>
  <pre>Updates an existing resource.

Args:
  part: string, The *part* parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet. (required) (repeated)
  body: object, The request body.
    The object takes the form of:

{ # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
  &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
  &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
  &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
  &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
    &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
      &quot;billingDetails&quot;: { # Information specific to billing. # Information specific to billing (read-only).
        &quot;billingStatus&quot;: &quot;A String&quot;, # The current billing profile status.
      },
      &quot;merchantAffiliateProgramDetails&quot;: { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
        &quot;status&quot;: &quot;A String&quot;, # The current merchant affiliate program status.
      },
      &quot;merchantId&quot;: &quot;A String&quot;, # Google Merchant Center id of the store.
      &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
      &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
    },
    &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
  },
  &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
    &quot;linkStatus&quot;: &quot;A String&quot;,
  },
}

  externalChannelId: string, Channel ID to which changes should be applied, for delegation.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
  &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
  &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
  &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
  &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
    &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
      &quot;billingDetails&quot;: { # Information specific to billing. # Information specific to billing (read-only).
        &quot;billingStatus&quot;: &quot;A String&quot;, # The current billing profile status.
      },
      &quot;merchantAffiliateProgramDetails&quot;: { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
        &quot;status&quot;: &quot;A String&quot;, # The current merchant affiliate program status.
      },
      &quot;merchantId&quot;: &quot;A String&quot;, # Google Merchant Center id of the store.
      &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
      &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
    },
    &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
  },
  &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
    &quot;linkStatus&quot;: &quot;A String&quot;,
  },
}</pre>
</div>

</body></html>