AdSense Management API . accounts . adclients . customchannels

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.

delete(name, x__xgafv=None)

Deletes a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.

get(name, x__xgafv=None)

Gets information about the selected custom channel.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the custom channels available in an ad client.

listLinkedAdUnits(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the ad units available for a custom channel.

listLinkedAdUnits_next()

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.

Args:
  parent: string, Required. The ad client to create a custom channel under. Format: accounts/{account}/adclients/{adclient} (required)
  body: object, The request body.
    The object takes the form of:

{ # Representation of a custom channel.
  "active": True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  "displayName": "A String", # Required. Display name of the custom channel.
  "name": "A String", # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a custom channel.
  "active": True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  "displayName": "A String", # Required. Display name of the custom channel.
  "name": "A String", # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}
delete(name, x__xgafv=None)
Deletes a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.

Args:
  name: string, Required. Name of the custom channel to delete. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
  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); }
}
get(name, x__xgafv=None)
Gets information about the selected custom channel.

Args:
  name: string, Required. Name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a custom channel.
  "active": True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  "displayName": "A String", # Required. Display name of the custom channel.
  "name": "A String", # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the custom channels available in an ad client.

Args:
  parent: string, Required. The ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient} (required)
  pageSize: integer, The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
  pageToken: string, A page token, received from a previous `ListCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomChannels` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response definition for the custom channel list rpc.
  "customChannels": [ # The custom channels returned in this list response.
    { # Representation of a custom channel.
      "active": True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
      "displayName": "A String", # Required. Display name of the custom channel.
      "name": "A String", # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
      "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
    },
  ],
  "nextPageToken": "A String", # Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's "page_token" value to this.
}
listLinkedAdUnits(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the ad units available for a custom channel.

Args:
  parent: string, Required. The custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
  pageSize: integer, The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
  pageToken: string, A page token, received from a previous `ListLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedAdUnits` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response definition for the ad units linked to a custom channel list rpc.
  "adUnits": [ # The ad units returned in the list response.
    { # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
      "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
        "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
        "type": "A String", # Required. Type of the ad unit.
      },
      "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
      "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
      "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
      "state": "A String", # State of the ad unit.
    },
  ],
  "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's "page_token" value to this.
}
listLinkedAdUnits_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.
        
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.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.

Args:
  name: string, Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} (required)
  body: object, The request body.
    The object takes the form of:

{ # Representation of a custom channel.
  "active": True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  "displayName": "A String", # Required. Display name of the custom channel.
  "name": "A String", # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}

  updateMask: string, The list of fields to update. If empty, a full update is performed.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a custom channel.
  "active": True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
  "displayName": "A String", # Required. Display name of the custom channel.
  "name": "A String", # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
}