View Source GoogleApi.CSS.V1.Api.Accounts (google_api_css v0.4.0)
API calls for all endpoints tagged Accounts
.
Summary
Functions
Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.
Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.
Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.
Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.
Retrieves a single CSS/MC account by ID.
Creates a new label, not assigned to any account.
Deletes a label and removes it from all accounts to which it was assigned.
Lists the labels assigned to an account.
Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.
Updates labels assigned to CSS/MC accounts by a CSS domain.
Functions
css_accounts_css_product_inputs_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_css_product_inputs_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CSS.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input} -
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"). -
:supplementalFeedId
(type:String.t
) - The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CSS.V1.Model.Empty{}}
on success -
{:error, info}
on failure
css_accounts_css_product_inputs_insert(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_css_product_inputs_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CSS.V1.Model.CssProductInput.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The account where this CSS Product will be inserted. 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"). -
:feedId
(type:String.t
) - Required. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet. -
:body
(type:GoogleApi.CSS.V1.Model.CssProductInput.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CSS.V1.Model.CssProductInput{}}
on success -
{:error, info}
on failure
css_accounts_css_products_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_css_products_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CSS.V1.Model.CssProduct.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the CSS product to retrieve. -
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.CSS.V1.Model.CssProduct{}}
on success -
{:error, info}
on failure
css_accounts_css_products_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_css_products_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CSS.V1.Model.ListCssProductsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The account/domain to list processed CSS Products 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"). -
:pageSize
(type:integer()
) - The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned. -
:pageToken
(type:String.t
) - A page token, received from a previousListCssProducts
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListCssProducts
must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CSS.V1.Model.ListCssProductsResponse{}}
on success -
{:error, info}
on failure
css_accounts_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.CSS.V1.Model.Account.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a single CSS/MC account by ID.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the managed CSS/MC account. 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"). -
:parent
(type:String.t
) - Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CSS.V1.Model.Account{}}
on success -
{:error, info}
on failure
css_accounts_labels_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_labels_create(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.CSS.V1.Model.AccountLabel.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new label, not assigned to any account.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent account. 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"). -
:body
(type:GoogleApi.CSS.V1.Model.AccountLabel.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CSS.V1.Model.AccountLabel{}}
on success -
{:error, info}
on failure
css_accounts_labels_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_labels_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.CSS.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a label and removes it from all accounts to which it was assigned.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the label to delete. Format: accounts/{account}/labels/{label} -
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.CSS.V1.Model.Empty{}}
on success -
{:error, info}
on failure
css_accounts_labels_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_labels_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.CSS.V1.Model.ListAccountLabelsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the labels assigned to an account.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent account. 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 labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken
(type:String.t
) - A page token, received from a previousListAccountLabels
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListAccountLabels
must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CSS.V1.Model.ListAccountLabelsResponse{}}
on success -
{:error, info}
on failure
css_accounts_labels_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_labels_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.CSS.V1.Model.AccountLabel.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a label.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource name of the label. Format: accounts/{account}/labels/{label} -
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.CSS.V1.Model.AccountLabel.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CSS.V1.Model.AccountLabel{}}
on success -
{:error, info}
on failure
css_accounts_list_child_accounts(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_list_child_accounts( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CSS.V1.Model.ListChildAccountsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent account. Must be a CSS group or domain. 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"). -
:fullName
(type:String.t
) - If set, only the MC accounts with the given name (case sensitive) will be returned. -
:labelId
(type:String.t
) - If set, only the MC accounts with the given label ID will be returned. -
:pageSize
(type:integer()
) - Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken
(type:String.t
) - Optional. A page token, received from a previousListChildAccounts
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListChildAccounts
must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CSS.V1.Model.ListChildAccountsResponse{}}
on success -
{:error, info}
on failure
css_accounts_update_labels(connection, name, optional_params \\ [], opts \\ [])
View Source@spec css_accounts_update_labels(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.CSS.V1.Model.Account.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates labels assigned to CSS/MC accounts by a CSS domain.
Parameters
-
connection
(type:GoogleApi.CSS.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The label resource name. 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"). -
:body
(type:GoogleApi.CSS.V1.Model.UpdateAccountLabelsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CSS.V1.Model.Account{}}
on success -
{:error, info}
on failure