# Display & Video 360 API . advertisers . channels . sites

## Instance Methods

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.

Close httplib2 connections.

Creates a site in a channel.

Deletes a site from a channel.

Lists sites in a channel.

Retrieves the next page of results.

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. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

### Method Details

`bulkEdit(advertiserId, channelId, body=None, x__xgafv=None)`

    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.
        },
      ],
    }

`close()`

    Close httplib2 connections.

`create(advertiserId, channelId, body=None, partnerId=None, x__xgafv=None)`

    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.
    }

`delete(advertiserId, channelId, urlOrAppId, partnerId=None, x__xgafv=None)`

    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); }
    }

`list(advertiserId, channelId, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)`

    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 retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
      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.
        },
      ],
    }

`list_next()`

    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.

`replace(advertiserId, channelId, body=None, x__xgafv=None)`

    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. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

    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.
        },
      ],
    }