View Source GoogleApi.AdSense.V2.Api.Accounts (google_api_ad_sense v0.16.0)

API calls for all endpoints tagged Accounts.

Summary

Functions

Creates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method. Note that ad units can only be created for ad clients with an "AFC" product code. For more info see the AdClient resource. For now, this method can only be used to create DISPLAY ad units. See: https://support.google.com/adsense/answer/9183566

Updates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method. For now, this method can only be used to update DISPLAY ad units. See: https://support.google.com/adsense/answer/9183566

Creates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method.

Deletes a custom channel. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method.

Updates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method.

Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see About the AdSense code.

Gets information about the selected AdSense account.

Lists all accounts directly managed by the given AdSense account.

Functions

Link to this function

adsense_accounts_adclients_adunits_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_adunits_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.AdUnit.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method. Note that ad units can only be created for ad clients with an "AFC" product code. For more info see the AdClient resource. For now, this method can only be used to create DISPLAY ad units. See: https://support.google.com/adsense/answer/9183566

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Ad client to create an ad unit under. Format: accounts/{account}/adclients/{adclient}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AdSense.V2.Model.AdUnit.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.AdUnit{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_adunits_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_adunits_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.AdUnit.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an ad unit from a specified account and ad client.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. AdUnit to get information about. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.AdUnit{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_adunits_get_adcode(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_adunits_get_adcode(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.AdUnitAdCode.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the ad unit code for a given ad unit. For more information, see About the AdSense code and Where to place the ad code in your HTML.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the adunit for which to get the adcode. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.AdUnitAdCode{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_adunits_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_adunits_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListAdUnitsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all ad units under a specified account and ad client.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The ad client which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: 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 (type: String.t) - A page token, received from a previous ListAdUnits call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAdUnits must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListAdUnitsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_adunits_list_linked_custom_channels(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_adunits_list_linked_custom_channels(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListLinkedCustomChannelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the custom channels available for an ad unit.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The ad unit which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: 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 (type: String.t) - A page token, received from a previous ListLinkedCustomChannels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLinkedCustomChannels must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListLinkedCustomChannelsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_adunits_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_adunits_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.AdUnit.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method. For now, this method can only be used to update DISPLAY ad units. See: https://support.google.com/adsense/answer/9183566

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - The list of fields to update. If empty, a full update is performed.
    • :body (type: GoogleApi.AdSense.V2.Model.AdUnit.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.AdUnit{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_customchannels_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_customchannels_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.CustomChannel.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The ad client to create a custom channel under. Format: accounts/{account}/adclients/{adclient}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AdSense.V2.Model.CustomChannel.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.CustomChannel{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_customchannels_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_customchannels_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a custom channel. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the custom channel to delete. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_customchannels_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_customchannels_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.CustomChannel.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets information about the selected custom channel.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.CustomChannel{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_customchannels_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_customchannels_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListCustomChannelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the custom channels available in an ad client.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: 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 (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListCustomChannelsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_customchannels_list_linked_ad_units(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_customchannels_list_linked_ad_units(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListLinkedAdUnitsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the ad units available for a custom channel.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: 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 (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListLinkedAdUnitsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_customchannels_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_customchannels_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.CustomChannel.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by AdSense for Platforms publishers. Contact your account manager if you need to use this method.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - The list of fields to update. If empty, a full update is performed.
    • :body (type: GoogleApi.AdSense.V2.Model.CustomChannel.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.CustomChannel{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.AdClient.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the ad client from the given resource name.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the ad client to retrieve. Format: accounts/{account}/adclients/{adclient}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.AdClient{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_get_adcode(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_get_adcode(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.AdClientAdCode.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see About the AdSense code.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the ad client for which to get the adcode. Format: accounts/{account}/adclients/{adclient}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.AdClientAdCode{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListAdClientsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the ad clients available in an account.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The account which owns the collection of ad clients. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - A page token, received from a previous ListAdClients call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAdClients must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListAdClientsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_urlchannels_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_urlchannels_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.UrlChannel.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets information about the selected url channel.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the url channel to retrieve. Format: accounts/{account}/adclients/{adclient}/urlchannels/{urlchannel}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.UrlChannel{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_adclients_urlchannels_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_adclients_urlchannels_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListUrlChannelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists active url channels.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The ad client which owns the collection of url channels. Format: accounts/{account}/adclients/{adclient}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - A page token, received from a previous ListUrlChannels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUrlChannels must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListUrlChannelsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_alerts_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_alerts_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListAlertsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the alerts available in an account.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The account which owns the collection of alerts. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - The language to use for translating alert messages. If unspecified, this defaults to the user's display language. If the given language is not supported, alerts will be returned in English. The language is specified as an IETF BCP-47 language code.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListAlertsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.AdSense.V2.Model.Account.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets information about the selected AdSense account.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Account to get information about. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.Account{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_get_ad_blocking_recovery_tag(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_get_ad_blocking_recovery_tag(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.AdBlockingRecoveryTag.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the ad blocking recovery tag of an account.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the account to get the tag for. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.AdBlockingRecoveryTag{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_list(connection, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListAccountsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all accounts available to this user.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListAccountsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_list_child_accounts(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_list_child_accounts(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListChildAccountsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all accounts directly managed by the given AdSense account.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent account, which owns the child accounts. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - A page token, received from a previous ListChildAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListChildAccounts must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListChildAccountsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_payments_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_payments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListPaymentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the payments available for an account.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The account which owns the collection of payments. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListPaymentsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_policy_issues_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_policy_issues_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.PolicyIssue.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets information about the selected policy issue.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the policy issue. Format: accounts/{account}/policyIssues/{policy_issue}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.PolicyIssue{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_policy_issues_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_policy_issues_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListPolicyIssuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the policy issues for the specified account.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The account for which policy issues are being retrieved. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of policy issues to include in the response, used for paging. If unspecified, at most 10000 policy issues will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - A page token, received from a previous ListPolicyIssues call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPolicyIssues must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListPolicyIssuesResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_reports_generate(connection, account, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_reports_generate(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ReportResult.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generates an ad hoc report.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • account (type: String.t) - Required. The account which owns the collection of reports. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :currencyCode (type: String.t) - The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.
    • :dateRange (type: String.t) - Date range of the report, if unset the range will be considered CUSTOM.
    • :dimensions (type: list(String.t)) - Dimensions to base the report on.
    • :"endDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"endDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"endDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    • :filters (type: list(String.t)) - A list of filters to apply to the report. All provided filters must match in order for the data to be included in the report.
    • :languageCode (type: String.t) - The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP-47 language code.
    • :limit (type: integer()) - The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for Reports.GenerateReport and 1,000,000 rows for Reports.GenerateCsvReport, which are also the maximum values permitted here. Report truncation can be identified (for Reports.GenerateReport only) by comparing the number of rows returned to the value returned in total_matched_rows.
    • :metrics (type: list(String.t)) - Required. Reporting metrics.
    • :orderBy (type: list(String.t)) - The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
    • :reportingTimeZone (type: String.t) - Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.
    • :"startDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"startDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"startDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ReportResult{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_reports_generate_csv(connection, account, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_reports_generate_csv(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.HttpBody.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generates a csv formatted ad hoc report.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • account (type: String.t) - Required. The account which owns the collection of reports. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :currencyCode (type: String.t) - The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.
    • :dateRange (type: String.t) - Date range of the report, if unset the range will be considered CUSTOM.
    • :dimensions (type: list(String.t)) - Dimensions to base the report on.
    • :"endDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"endDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"endDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    • :filters (type: list(String.t)) - A list of filters to apply to the report. All provided filters must match in order for the data to be included in the report.
    • :languageCode (type: String.t) - The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP-47 language code.
    • :limit (type: integer()) - The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for Reports.GenerateReport and 1,000,000 rows for Reports.GenerateCsvReport, which are also the maximum values permitted here. Report truncation can be identified (for Reports.GenerateReport only) by comparing the number of rows returned to the value returned in total_matched_rows.
    • :metrics (type: list(String.t)) - Required. Reporting metrics.
    • :orderBy (type: list(String.t)) - The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
    • :reportingTimeZone (type: String.t) - Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.
    • :"startDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"startDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"startDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.HttpBody{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_reports_get_saved(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_reports_get_saved(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.SavedReport.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the saved report from the given resource name.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the saved report to retrieve. Format: accounts/{account}/reports/{report}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.SavedReport{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_reports_saved_generate(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_reports_saved_generate(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ReportResult.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generates a saved report.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the saved report. Format: accounts/{account}/reports/{report}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :currencyCode (type: String.t) - The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.
    • :dateRange (type: String.t) - Date range of the report, if unset the range will be considered CUSTOM.
    • :"endDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"endDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"endDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    • :languageCode (type: String.t) - The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP-47 language code.
    • :reportingTimeZone (type: String.t) - Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.
    • :"startDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"startDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"startDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ReportResult{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_reports_saved_generate_csv(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_reports_saved_generate_csv(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.HttpBody.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generates a csv formatted saved report.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the saved report. Format: accounts/{account}/reports/{report}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :currencyCode (type: String.t) - The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.
    • :dateRange (type: String.t) - Date range of the report, if unset the range will be considered CUSTOM.
    • :"endDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"endDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"endDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    • :languageCode (type: String.t) - The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP-47 language code.
    • :reportingTimeZone (type: String.t) - Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.
    • :"startDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"startDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"startDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.HttpBody{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_reports_saved_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_reports_saved_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListSavedReportsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists saved reports.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The account which owns the collection of reports. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of reports to include in the response, used for paging. If unspecified, at most 10000 reports will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - A page token, received from a previous ListSavedReports call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSavedReports must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListSavedReportsResponse{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_sites_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_sites_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.AdSense.V2.Model.Site.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets information about the selected site.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the site. Format: accounts/{account}/sites/{site}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.Site{}} on success
  • {:error, info} on failure
Link to this function

adsense_accounts_sites_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec adsense_accounts_sites_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdSense.V2.Model.ListSitesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the sites available in an account.

Parameters

  • connection (type: GoogleApi.AdSense.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The account which owns the collection of sites. Format: accounts/{account}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
    • :pageToken (type: String.t) - A page token, received from a previous ListSites call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSites must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdSense.V2.Model.ListSitesResponse{}} on success
  • {:error, info} on failure