281 lines
12 KiB
HTML
281 lines
12 KiB
HTML
<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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.channels.html">channels</a> . <a href="displayvideo_v1.advertisers.channels.sites.html">sites</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#bulkEdit">bulkEdit(advertiserId, channelId, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.</p>
|
|
<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="#create">create(advertiserId, channelId, body=None, partnerId=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Creates a site in a channel.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#delete">delete(advertiserId, channelId, urlOrAppId, partnerId=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Deletes a site from a channel.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(advertiserId, channelId, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Lists sites in a channel.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#replace">replace(advertiserId, channelId, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="bulkEdit">bulkEdit(advertiserId, channelId, body=None, x__xgafv=None)</code>
|
|
<pre>Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
|
|
|
|
Args:
|
|
advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
|
|
channelId: string, Required. The ID of the parent channel to which the sites belong. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # Request message for SiteService.BulkEditSites.
|
|
"advertiserId": "A String", # The ID of the advertiser that owns the parent channel.
|
|
"createdSites": [ # The sites to create in batch, specified as a list of Sites.
|
|
{ # A single site. Sites are apps or websites belonging to a channel.
|
|
"name": "A String", # Output only. The resource name of the site.
|
|
"urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
|
|
},
|
|
],
|
|
"deletedSites": [ # The sites to delete in batch, specified as a list of site url_or_app_ids.
|
|
"A String",
|
|
],
|
|
"partnerId": "A String", # The ID of the partner that owns the parent channel.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response message for SiteService.BulkEditSites.
|
|
"sites": [ # The list of sites that have been successfully created. This list will be absent if empty.
|
|
{ # A single site. Sites are apps or websites belonging to a channel.
|
|
"name": "A String", # Output only. The resource name of the site.
|
|
"urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="close">close()</code>
|
|
<pre>Close httplib2 connections.</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="create">create(advertiserId, channelId, body=None, partnerId=None, x__xgafv=None)</code>
|
|
<pre>Creates a site in a channel.
|
|
|
|
Args:
|
|
advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
|
|
channelId: string, Required. The ID of the parent channel in which the site will be created. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # A single site. Sites are apps or websites belonging to a channel.
|
|
"name": "A String", # Output only. The resource name of the site.
|
|
"urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
|
|
}
|
|
|
|
partnerId: string, The ID of the partner that owns the parent channel.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A single site. Sites are apps or websites belonging to a channel.
|
|
"name": "A String", # Output only. The resource name of the site.
|
|
"urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="delete">delete(advertiserId, channelId, urlOrAppId, partnerId=None, x__xgafv=None)</code>
|
|
<pre>Deletes a site from a channel.
|
|
|
|
Args:
|
|
advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
|
|
channelId: string, Required. The ID of the parent channel to which the site belongs. (required)
|
|
urlOrAppId: string, Required. The URL or app ID of the site to delete. (required)
|
|
partnerId: string, The ID of the partner that owns the parent channel.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(advertiserId, channelId, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
|
|
<pre>Lists sites in a channel.
|
|
|
|
Args:
|
|
advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
|
|
channelId: string, Required. The ID of the parent channel to which the requested sites belong. (required)
|
|
filter: string, Allows filtering by site fields. Supported syntax: * Filter expressions for site currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"`
|
|
orderBy: string, Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.
|
|
pageSize: integer, Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
|
|
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.
|
|
partnerId: string, The ID of the partner that owns the parent channel.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response message for SiteService.ListSites.
|
|
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results.
|
|
"sites": [ # The list of sites. This list will be absent if empty.
|
|
{ # A single site. Sites are apps or websites belonging to a channel.
|
|
"name": "A String", # Output only. The resource name of the site.
|
|
"urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="replace">replace(advertiserId, channelId, body=None, x__xgafv=None)</code>
|
|
<pre>Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites.
|
|
|
|
Args:
|
|
advertiserId: string, The ID of the advertiser that owns the parent channel. (required)
|
|
channelId: string, Required. The ID of the parent channel whose sites will be replaced. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # Request message for SiteService.ReplaceSites.
|
|
"advertiserId": "A String", # The ID of the advertiser that owns the parent channel.
|
|
"newSites": [ # The sites that will replace the existing sites assigned to the channel, specified as a list of Sites.
|
|
{ # A single site. Sites are apps or websites belonging to a channel.
|
|
"name": "A String", # Output only. The resource name of the site.
|
|
"urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
|
|
},
|
|
],
|
|
"partnerId": "A String", # The ID of the partner that owns the parent channel.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response message for SiteService.ReplaceSites.
|
|
"sites": [ # The list of sites in the channel after replacing.
|
|
{ # A single site. Sites are apps or websites belonging to a channel.
|
|
"name": "A String", # Output only. The resource name of the site.
|
|
"urlOrAppId": "A String", # Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |